Payment Report
Generate reports with filtered payment data for clear insights
Our paginated payments endpoint is designed to provide an efficient and user-friendly way to retrieve payment data. It offers robust filtering options to ensure you can access the specific information you need quickly and easily.
GET https://sandbox-api.veem.com/veem/v1.2/payments/report
Headers:
X-Request-Id:
Authorization: Bearer <access_token>
Notes:
X-Request-Id can be any string, but it must be unique for each different transaction you do using the same account. We recommend generating this value as a GUID, and save it for reference. You cannot create two different payments using the same X-Request-Id value, if you try it, you simple get the date for the first payment created using that value.
Parameters:
| Paramenter | Description | Mandatory |
|---|---|---|
| startDate | The starting date used to filter records. This date corresponds to the creation date of the payment within the Veem system. Only entries from this date onward will be included. The date should follow the ISO 8601 format. The time range for each query is limited to a maximum duration of 1 year | yes |
| endDate | The ending date used to filter records. This date corresponds to the creation date of the payment within the Veem system. The date should follow the ISO 8601 format. The time range for each query is limited to a maximum duration of 1 year | yes |
| status | The current status of the payment records to be returned: Drafted Sent PendingAuth Authorized InProgress Complete Cancelled Closed | no |
| pageNumber | Number of page user want to get payments | no |
| pageSize | Number of records per page. If not specified, the default number will be 20 | no |
Parameter examples:
| Example | Description |
|---|---|
| GET /veem/v1.2/payments/report?startDate=2024-11-18&endDate=2024-11-18 | Get all payments between for the day 18 November 2024 |
| GET /veem/v1.2/payments/report?startDate=2024-11-18&endDate=2024-11-20&status=approved | Get all payments on the determined date and status approved |
| GET /veem/v1.2/payments/report?startDate=2024-11-18&endDate=2023-11-18&pageNumber=2&pageSize=20 | Get all payments on the determined date, requiring 20 records per page and getting records for the second page |
Example Response
{
"content": [
{
"id": 461353,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 580.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 580.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T07:23:46.983-07:00"
},
{
"id": 461354,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 320.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 320.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T07:27:09.416-07:00"
},
{
"id": 461355,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 380.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 380.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T07:35:57.535-07:00"
},
{
"id": 461356,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 300.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "VN",
"payerAmount": {
"number": 300.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T09:56:35.922-07:00"
},
{
"id": 461357,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 450.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "VN",
"payerAmount": {
"number": 450.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T11:35:28.255-07:00"
},
{
"id": 461358,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 880.00,
"currency": "USD"
}
},
"payer": {
"countryCode": "VN",
"payerAmount": {
"number": 880.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T11:38:59.633-07:00"
},
{
"id": 461362,
"status": "Complete",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 2625.44,
"currency": "PHP"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 50.00,
"currency": "USD"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T11:55:49.459-07:00"
},
{
"id": 461363,
"status": "Drafted",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 45.05,
"currency": "USD"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 2953.10,
"currency": "PHP"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T12:16:10.235-07:00"
},
{
"id": 461364,
"status": "Drafted",
"payee": {
"countryCode": "US",
"payeeAmount": {
"number": 45.05,
"currency": "USD"
}
},
"payer": {
"countryCode": "US",
"payerAmount": {
"number": 2953.10,
"currency": "PHP"
},
"payerAccountId": 942800
},
"timeCreated": "2024-11-01T12:16:20.999-07:00"
}
],
"numberOfElements": 9,
"size": 10,
"number": 0,
"last": true,
"first": true,
"sort": [
{
"direction": "ASC",
"property": "timeCreated"
}
],
"totalPages": 1,
"totalElements": 9
}
The following table describes the various payment status values:
| Status | Description |
|---|---|
| Drafted | Payment is in drafted state and requires further updates. |
| Sent | The payment has been sent to the receiver/payee. |
| PendingAuth | The payment is in pending authorization by Veem. |
| Authorized | The payment has been authorized and is ready for processing. The money will be withdrawn from sender's bank. |
| InProgress | The payment has been initiated and receiver will be receiving money shortly. |
| Complete | The payment is complete and the receiver should have received the money. |
| Cancelled | The payment has been cancelled by the sender/payer. |
| Closed | The payment has been closed by Veem by request from the sender, or receiver, or due to an error with the payment. |
Validation errors
| Code | Numeric Code | Description |
|---|---|---|
| DATE_CAN_NOT_BE_BIGGER_1_YEAR | 50001106 | The date range cannot exceed one year |
| END_DATE_CAN_NOT_BE_EARLIER_THAN_START_DATE | 50001107 | End date cannot be earlier than start date |
| START_DATE_CAN_NOT_BE_IN_THE_FUTURE | 50001108 | Start date cannot be in the future |
Updated 4 days ago