- Home
- API References
- JSON API reference
- Transfers
- Getting transfers list
Getting transfers list
Getting transfers list
Example Request
Copied!
curl https://api.worldpay.com/v1/transfers?
merchantId={merchantId}&page={pageNumber}
-H "Authorization:your-test-service-key"
-H "Content-type: application/json"
-X GET
curl https://api.worldpay.com/v1/transfers? merchantId={merchantId}&page={pageNumber} -H "Authorization:your-test-service-key" -H "Content-type: application/json" -X GET
Example Response
Copied!
{
"currentPageNumber": 0,
"totalPages": 1,
"numberOfElements": 2,
"transfers": [
{
"netAmount": 78,
"settlementCurrency": "GBP",
"settlementCurrencyExponent": 2,
"bankName": "HSBC Bank",
"accountNumber": " 5678",
"transferDate": "2015-04-16T22:52:49.000+0000",
"transferId": "e09c43d4-e3bc-4518-a3da-d1367d675fc2",
"batchId": "1",
"merchantCode": "MERCHANTCODE1"
},
{
"netAmount": 80,
"settlementCurrency": "GBP",
"settlementCurrencyExponent": 2,
"bankName": "HSBC Bank",
"accountNumber": " 5678",
"transferDate": "2015-04-16T22:52:49.000+0000",
"transferId": "c0511cbf-bfde-410d-b8b5-3fd4e12a792d",
"batchId": "1",
"merchantCode": "MERCHANTCODE1MO"
}
]
}
{ "currentPageNumber": 0, "totalPages": 1, "numberOfElements": 2, "transfers": [ { "netAmount": 78, "settlementCurrency": "GBP", "settlementCurrencyExponent": 2, "bankName": "HSBC Bank", "accountNumber": " 5678", "transferDate": "2015-04-16T22:52:49.000+0000", "transferId": "e09c43d4-e3bc-4518-a3da-d1367d675fc2", "batchId": "1", "merchantCode": "MERCHANTCODE1" }, { "netAmount": 80, "settlementCurrency": "GBP", "settlementCurrencyExponent": 2, "bankName": "HSBC Bank", "accountNumber": " 5678", "transferDate": "2015-04-16T22:52:49.000+0000", "transferId": "c0511cbf-bfde-410d-b8b5-3fd4e12a792d", "batchId": "1", "merchantCode": "MERCHANTCODE1MO" } ] }
Overview of all transfers can be obtained by sending a get request.
Query parameters
merchantID | String, Mandatory merchantID of the account you want to retrieve orders for. This field is only relevant for partners who manage more than one account |
page | String, Optional Get Transfers will only return 20 orders per page. This field allows you to specify which page you want to retrieve. Note: the first page is page 0. |