Menu

Transfers

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"
    }
  ]
}

All transfer fields are limited to 255 chars in length.

Transfer object

currentPageNumberString, only included in response
To reduce the amount of data sent in the Get Transfers response, the response is split up in pages. This field contains the page number for the current page. Note: the first page is page 0.
totalPagesString, only included in response
Total number of pages over which the response is split.
numberOfElementsString, only included in response
Number of transfers included on this page.
transfersJSON, only included in response
Object containing all transfers
netAmountInteger, only included in response
The amount that will be settled to you after commissions have been deducted in cents
settlementCurrencyString, only included in response
The ISO currency code of the currency that you will be settled in. 'netAmount' will be in this currency. A list of ISO currency codes can be foundhere
settlementCurrencyExponentString, only included in response
The number of decimals after the dot for this currency. The value will be 2 for most currencies but can sometimes be 3.
bankNameString, only included in response
Name of the bank this transfer was paid to.
accountNumberString, only included in response
Masked account number this transfer was paid into.
transferDateString, only included in response
Date on which this transfer was paid.
transferIdString, only included in response
Worldpay generated identifier for this transfer.
batchIDString, only included in response
Worldpay generated batch ID for this transfer.
merchantCodeString, only included in response
Code shown on your settlement page (requires you to be logged in).