List Transactions

List Transactions

GET {{Environment_URL}}/vendors/v1/charges

This endpoint allows you to retrieve a list paginated of transactions.

Headers

Name	Value
Authorization	Bearer <token>

Query Params

Name	Description	Value
limit	Documents per page ∙ Min 15 | Max 100 | Default 15	15
page	Page number	0
externalId	Specific payment identifier	myid_001
amount	Value in Brazilian cents	10000
status	Operation status ∙ CREATED | AWAITING | PAID | REFUNDED | CANCELED	CREATED
rangeStart	Initial interval for operation value ∙ Must be used with rangeEnd	10000
rangeEnd	Final interval for operation value ∙ Must be used with rangeStart	15000
createdAtStart	Initial cretedAt date interval ∙ Must be used with createdAtEnd	YYYY-MM-DD
createdAtEnd	Initial cretedAt date interval ∙ Must be used with createdAtStart	YYYY-MM-DD
updatedAtStart	Initial updateAt date interval ∙ Must be used with updatedAtEnd	YYYY-MM-DD
updatedAtEnd	Final updatedAt date interval ∙ Must be used with updatedAtStart	YYYY-MM-DD

Response

200 - OK

{
    "page": 1,
    "totalPages": 170,
    "docsShown": 15,
    "totalDocs": 2545,
    "docs": [
        {
            "id": "ch_01hfytbyja34w682m1047c2qyb",
            "amount": 100,
            "currency": "USD",
            "metadata": null,
            "quotation": {
                "id": "f1140fd937d9c14f7bf875cb5e0a7f01e190e55e",
                "tax": {
                    "iof": {
                        "total": {
                            "value": 2,
                            "divisor": 100,
                            "currency": "BRL",
                            "precision": 2
                        },
                        "percentage": 0.38
                    }
                },
                "total": {
                    "withTax": {
                        "value": 540,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withoutTax": {
                        "value": 538,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withFutureTax": {
                        "value": 566,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withTaxesAndFees": {
                        "value": 566,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    }
                },
                "currency": {
                    "code": "USD",
                    "fees": [
                        {
                            "name": "FEE_FC",
                            "type": "absolute",
                            "value": 5,
                            "netValue": {
                                "value": 27,
                                "divisor": 100,
                                "currency": "BRL",
                                "precision": 2
                            },
                            "receiver": "PLATFORM_FEE"
                        }
                    ],
                    "name": "Dólar Americano",
                    "offer": {
                        "value": 100,
                        "divisor": 100,
                        "currency": "USD",
                        "precision": 2
                    },
                    "price": {
                        "withTax": {
                            "value": 53966,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withoutTax": {
                            "value": 53761,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withFutureTax": {
                            "value": 56627,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withTaxesAndFees": {
                            "value": 56627,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        }
                    },
                    "spreads": [
                        {
                            "name": "FEE_VENDOR",
                            "type": "percentage",
                            "netValue": {
                                "value": 5,
                                "divisor": 100,
                                "currency": "BRL",
                                "precision": 2
                            },
                            "receiver": "VENDOR_FEE",
                            "percentage": 1
                        }
                    ],
                    "offerUSD": {
                        "value": 100,
                        "divisor": 100,
                        "currency": "USD",
                        "precision": 2
                    },
                    "levelingRate": {
                        "value": 53229,
                        "divisor": 10000,
                        "currency": "BRL",
                        "precision": 4
                    },
                    "countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-dev/new-flags/united-states.svg",
                    "commercialExchangeRate": {
                        "value": 48370,
                        "divisor": 10000,
                        "currency": "BRL",
                        "precision": 4,
                        "updatedAt": "2023-06-15T12:48:23.000Z"
                    }
                },
                "createdAt": "2023-11-23T19:25:39.810Z",
                "futureTax": {
                    "ir": {
                        "total": {
                            "value": 0,
                            "divisor": 100,
                            "currency": "BRL",
                            "precision": 2
                        },
                        "percentage": 0
                    }
                }
            },
            "nature": "SERVICES_AND_OTHERS",
            "status": "PENDING",
            "createdAt": "2023-11-23T19:26:35.076Z",
            "updatedAt": "2023-11-23T19:26:35.076Z"
        },
        {
            "id": "ch_01hfyt7we2r51dh3e5tnrrrdnw",
            "amount": 100,
            "currency": "USD",
            "metadata": null,
            "quotation": {
                "id": "ad6a80fec5a50276cc05d0a8c5e4008c98ed3c17",
                "tax": {
                    "iof": {
                        "total": {
                            "value": 2,
                            "divisor": 100,
                            "currency": "BRL",
                            "precision": 2
                        },
                        "percentage": 0.38
                    }
                },
                "total": {
                    "withTax": {
                        "value": 540,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withoutTax": {
                        "value": 538,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withFutureTax": {
                        "value": 566,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    },
                    "withTaxesAndFees": {
                        "value": 566,
                        "divisor": 100,
                        "currency": "BRL",
                        "precision": 2
                    }
                },
                "currency": {
                    "code": "USD",
                    "fees": [
                        {
                            "name": "FEE_FC",
                            "type": "absolute",
                            "value": 5,
                            "netValue": {
                                "value": 27,
                                "divisor": 100,
                                "currency": "BRL",
                                "precision": 2
                            },
                            "receiver": "PLATFORM_FEE"
                        }
                    ],
                    "name": "Dólar Americano",
                    "offer": {
                        "value": 100,
                        "divisor": 100,
                        "currency": "USD",
                        "precision": 2
                    },
                    "price": {
                        "withTax": {
                            "value": 53966,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withoutTax": {
                            "value": 53761,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withFutureTax": {
                            "value": 56627,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        },
                        "withTaxesAndFees": {
                            "value": 56627,
                            "divisor": 10000,
                            "currency": "BRL",
                            "precision": 4
                        }
                    },
                    "spreads": [
                        {
                            "name": "FEE_VENDOR",
                            "type": "percentage",
                            "netValue": {
                                "value": 5,
                                "divisor": 100,
                                "currency": "BRL",
                                "precision": 2
                            },
                            "receiver": "VENDOR_FEE",
                            "percentage": 1
                        }
                    ],
                    "offerUSD": {
                        "value": 100,
                        "divisor": 100,
                        "currency": "USD",
                        "precision": 2
                    },
                    "levelingRate": {
                        "value": 53229,
                        "divisor": 10000,
                        "currency": "BRL",
                        "precision": 4
                    },
                    "countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-dev/new-flags/united-states.svg",
                    "commercialExchangeRate": {
                        "value": 48370,
                        "divisor": 10000,
                        "currency": "BRL",
                        "precision": 4,
                        "updatedAt": "2023-06-15T12:48:23.000Z"
                    }
                },
                "createdAt": "2023-11-23T19:24:14.778Z",
                "futureTax": {
                    "ir": {
                        "total": {
                            "value": 0,
                            "divisor": 100,
                            "currency": "BRL",
                            "precision": 2
                        },
                        "percentage": 0
                    }
                }
            },
            "nature": "SERVICES_AND_OTHERS",
            "status": "PENDING",
            "createdAt": "2023-11-23T19:24:21.804Z",
            "updatedAt": "2023-11-23T19:24:21.804Z"
        }
    ]
}