List all payment requests
GET {{baseUrl}}/payment_requests
List all payment requests associated with your account
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page | number | A page number within the paginated result set. | |
limit | number | Indicates how many results to return per page. By default we return 20 results | |
per page. |
ā¹ļø The minimum number of results returned per page is 1 and the maximum is 100.
If you enter a value greater than 100, our API will default to the maximum
value (100).
|
| search
| string | | Return results that match the reference
you searched for.
Note:
This filter supports both full and partial search queries. For example, searching for trai
may match the following values (extacted
from the reference
field)):
Awesome training sneakers
Training equipment
| |customer_id
| string | | The unique identifier created by Belvo used to reference the customer. | |order
| string | | Return results in either ascending (oldest to newest) or descending (newest to oldest) order, according to thecreatedDate
.
Can be either:
asc
for ascending orderdesc
for descending order | |start_date
| string | | Return items with acreatedDate
greater than or equal to the specified date. The date must be in the formatYYYY-MM-DD
. | |end_date
| string | | Return items with acreatedDate
less than or equal to the specified date. The date must be in the formatYYYY-MM-DD
. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c","createdDate":"2022-02-09T08:45:50.406032Z","lastUpdatedDate":"2022-02-09T08:45:50.406032Z","status":"processing","failedReason":null,"failedReasonMessage":null,"amount":"100000.00","currency":"mxn","customer":"3118128a-6792-4b06-bd61-4acf6f6ad6b5","customerName":"Carlos Vives","reference":"Monthly gym subscription","paymentMethod":{"type":"bank_account","details":{"accountNumber":"445566790","accountType":"savings","bank":"mx_citi_banamex"}}},{"id":"0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c","createdDate":"2022-02-09T08:45:50.406032Z","lastUpdatedDate":"2022-02-09T08:45:50.406032Z","status":"processing","failedReason":null,"failedReasonMessage":null,"amount":"100000.00","currency":"mxn","customer":"3118128a-6792-4b06-bd61-4acf6f6ad6b5","customerName":"Carlos Vives","reference":"Monthly gym subscription","paymentMethod":{"type":"bank_account","details":{"accountNumber":"445566790","accountType":"savings","bank":"mx_citi_banamex"}}}],"metadata":{"totalItems":100,"itemCount":10,"itemsPerPage":10,"totalPages":10,"currentPage":1},"links":{"first":"/customers?limit=20","last":"/customers?page=4\u0026limit=20","next":"/customers?page=3\u0026limit=20","previous":"/customers?page=2\u0026limit=20"}}