Payment Report
Generate reports with filtered payment data for clear insights
Payment Report for One Customer
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
Three headers are required to use this endpoint.
Required Headers
Name
Type
Required
Description
Authorization
stringYes
Bearer token (OAuth 2.0) This header holds the bearer token required to use Veem's public API, and belongs to the owner account. Failure to use a valid bearer token will result in a 404 (Not Found) status code in the response. An example of a valid header value is as follows:
Bearer c047594b-082c-4da1-be89-08fe3770f4b3See Get Access Token section to generate your Bearer token
X-Request-Id
stringYes
This is a unique string that identifies the current API request, and should follow the UUID format. Reusing this header without changing the value will result in a 409 (Conflict) status code in the response. An example X-request-id is as follows:
48855846-628d-4177-b071-80332a116f0a
Content-Type
stringYes
The content type of the request. Must be
application/json
Query String 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 | 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 |
Partner Notes:
- A partner account can be configured to make this API request on behalf of their customers. This requires internal configuration for the partner account by Veem. Once the internal configuration is enabled, the API request can be made using partner account bearer token.
onBehalfAccountIdis an optional query string parameter, this needs to be included in the request URL in case of partner making an API request on behalf of their customer. This is the customer Veem accountId, e.g?onBehalfAccountId=457725
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
}Refer to Payment Statuses section for a detailed description of the various payment status values.
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 |
Payment Report for All Customers
This endpoint is available for partner accounts previously set up by Veem. Our paginated payments endpoint is designed to provide an efficient and user-friendly way to retrieve payment data for all partner customers at once. 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/partner-report
Headers
Three headers are required to use this endpoint.
Required Headers
Name
Type
Required
Description
Authorization
stringYes
Bearer token (OAuth 2.0) This header holds the partner bearer token required to use Veem's public API, and belongs to the partner account. Failure to use a valid bearer token will result in a 404 (Not Found) status code in the response. An example of a valid header value is as follows:
Bearer c047594b-082c-4da1-be89-08fe3770f4b3See Get Access Token section to generate your Bearer token
X-Request-Id
stringYes
This is a unique string that identifies the current API request, and should follow the UUID format. Reusing this header without changing the value will result in a 409 (Conflict) status code in the response. An example X-request-id is as follows:
48855846-628d-4177-b071-80332a116f0a
Content-Type
stringYes
The content type of the request. Must be
application/json
Example Response
{
"number": 0,
"size": 2,
"totalPages": 248,
"numberOfElements": 2,
"totalElements": 496,
"previousPage": false,
"nextPage": false,
"first": true,
"last": false,
"content": [
{
"payee": {
"countryCode": "VN",
"payeeAmount": {
"number": 261851.61,
"currency": "VND"
}
},
"payer": {
"countryCode": "CA",
"payerAmount": {
"number": 13.97,
"currency": "CAD"
},
"payerAccountId": 394963
},
"status": "Closed",
"goodFundsPayment": true,
"id": 1463264,
"exchangeRate": {
"fromAmount": 13.97,
"fromCurrency": "CAD",
"toAmount": 10.00,
"toCurrency": "USD"
},
"feeInformation": {
"payerInfo": {
"originalAmount": 10.00,
"feeAmount": 3.97,
"totalAmount": 13.97,
"currency": "CAD",
"fees": [
{
"name": "FX Markup",
"displayValue": "0.003000 CAD->USD",
"priceItemType": "FX_INVERSE_MARKUP",
"rate": 0.003000
},
{
"name": "FX Marked Up",
"displayValue": "0.718420000000 CAD->USD",
"priceItemType": "FX_TOTAL_RATE",
"rate": 0.716265
},
{
"name": "Veem Internal FX Markup",
"displayValue": "VIR: 26274.458759 USD->VND",
"priceItemType": "FX_INVERSE_VEEM_INTERNAL_MARKUP",
"rate": 0.000400
}
]
},
"payeeInfo": {
"originalAmount": 262639.53,
"feeAmount": 787.92,
"totalAmount": 261851.61,
"currency": "VND",
"fees": [
{
"name": "FX Markup",
"displayValue": "0.003000 USD->VND",
"priceItemType": "FX_MARKUP",
"rate": 0.003000
},
{
"name": "FX Marked Up",
"displayValue": "26263.953178000000 USD->VND",
"priceItemType": "FX_TOTAL_RATE",
"rate": 26185.161318
}
]
}
},
"timeCreated": "2026-01-10T18:58:06.661-08:00",
"timeUpdated": "2026-01-20T21:44:35.650-08:00"
},
{
"payee": {
"countryCode": "VN",
"payeeAmount": {
"number": 261822.17,
"currency": "VND"
}
},
"payer": {
"countryCode": "CA",
"payerAmount": {
"number": 13.94,
"currency": "CAD"
},
"payerAccountId": 394963
},
"status": "Closed",
"goodFundsPayment": true,
"id": 1463635,
"exchangeRate": {
"fromAmount": 13.94,
"fromCurrency": "CAD",
"toAmount": 10.00,
"toCurrency": "USD"
},
"feeInformation": {
"payerInfo": {
"originalAmount": 10.00,
"feeAmount": 3.94,
"totalAmount": 13.94,
"currency": "CAD",
"fees": [
{
"name": "FX Markup",
"displayValue": "0.003000 CAD->USD",
"priceItemType": "FX_INVERSE_MARKUP",
"rate": 0.003000
},
{
"name": "FX Marked Up",
"displayValue": "0.719840000000 CAD->USD",
"priceItemType": "FX_TOTAL_RATE",
"rate": 0.717680
},
{
"name": "Veem Internal FX Markup",
"displayValue": "VIR: 26271.504400 USD->VND",
"priceItemType": "FX_INVERSE_VEEM_INTERNAL_MARKUP",
"rate": 0.000400
}
]
},
"payeeInfo": {
"originalAmount": 262610.00,
"feeAmount": 787.83,
"totalAmount": 261822.17,
"currency": "VND",
"fees": [
{
"name": "FX Markup",
"displayValue": "0.003000 USD->VND",
"priceItemType": "FX_MARKUP",
"rate": 0.003000
},
{
"name": "FX Marked Up",
"displayValue": "26261.000000000000 USD->VND",
"priceItemType": "FX_TOTAL_RATE",
"rate": 26182.217000
}
]
}
},
"timeCreated": "2026-01-11T18:58:18.620-08:00",
"timeUpdated": "2026-01-20T21:44:35.650-08:00"
}
]
}Refer to Payment Statuses section for a detailed description of the various payment status values.
Query String Parameters
Query String Parameters section above describes all parameters supported for this endpoint.
Validation Errors
The same Validation Errors as described above are applicable for this endpoint.
Updated about 15 hours ago