Menu

Getting transfer details

Getting transfer details

Example Request

Copied!
curl https://api.worldpay.com/v1/transfers/[your-transfer-id]
-H "Authorization:your-service-key"
-H "Content-type: application/json"
-X GET

Example Response

Copied!
{
   "transferId":"7aca9598-94ba-43af-bd35-2f00a4477500",
   "orders":[ ... ],
   "batchId":"7",
   "merchantCode":"WPDENDAWFBSKL3GBPMO",
   "reportDate":"2015-07-15T00:00:00.000+0000",
   "settlementCurrency":"GBP",
   "transferDate":"2015-07-15T09:55:45.000+0000",
   "transferDetails":{
      "paymentsSettled":[
         {
            "modificationDate":"2015-07-14T00:00:00.000+0000",
            "orderCode":"9d62cdb2-e6aa-41c6-8295-24b1446d5eee",
            "customerOrderCode":"TfrReport_03",
            "cardType":"VISA_CREDIT",
            "currencyCode":"EUR",
            "currencyCodeExponent":2,
            "amount":21130,
            "exchangeRate":"1 EUR = 0.70359 GBP",
            "commission":610,
            "netAmount":14257
         }
      ],
      "paymentChargeBacks":[
         {
            "modificationDate":"2015-07-14T00:00:00.000+0000",
            "orderCode":"9d62cdb2-e6aa-41c6-8295-24b1446d5eee",
            "customerOrderCode":"TfrReport_03",
            "cardType":"VISA_CREDIT",
            "currencyCode":"EUR",
            "currencyCodeExponent":2,
            "amount":4588,
            "commission":0,
            "netAmount":-3228
         }
      ],
      "paymentReverseChargeBacks":[
         {
            "modificationDate":"2015-07-14T00:00:00.000+0000",
            "orderCode":"9d62cdb2-e6aa-41c6-8295-24b1446d5eee",
            "customerOrderCode":"TfrReport_03",
            "cardType":"VISA_CREDIT",
            "currencyCode":"EUR",
            "currencyCodeExponent":2,
            "amount":4588,
            "commission":0,
            "netAmount":3228
         }
      ],
      "paymentRefunds":[
         {
            "modificationDate":"2015-07-14T00:00:00.000+0000",
            "orderCode":"de48bf4f-66c7-4555-8f06-71cc310f428d",
            "customerOrderCode":"TfrReport_01",
            "cardType":"VISA_CREDIT",
            "currencyCode":"EUR",
            "currencyCodeExponent":2,
            "amount":8999,
            "exchangeRate":"1 EUR = 0.70359 GBP",
            "commission":0,
            "netAmount":-6332
         }
      ]
   },
   "miscellaneousDetails":[
      {
         "description":"Invoice CLEARWATER-RC17",
         "netAmount":-842,
         "settlementCurrency":"GBP",
         "settlementCurrencyExponent":2
      },
      {
         "description":"incorrect charges - transfer 15-JUL-15 23.53",
         "netAmount":345,
         "settlementCurrency":"GBP",
         "settlementCurrencyExponent":2
      },
      {
         "description":"incorrect route caused roboivo failure 190215 dk",
         "netAmount":236,
         "settlementCurrency":"GBP",
         "settlementCurrencyExponent":2
      }
   ],
   "depositCorrectionDetail":{
      "description":"deposit Jul 15 2015 10:56PM. Correction to meet th",
      "netAmount":-991,
      "settlementCurrency":"GBP",
      "settlementCurrencyExponent":2
   },
   "transferNetAmount":-6673,
   "transferAmountCurrencyCode":"GBP",
   "transferAmountCurrencyCodeExponent":2
}

Transfer details can be obtained by sending a get request.

Transfer details object

transferIdString, only included in response
Worldpay generated identifier for this transfer.
ordersJSON, deprecated
Object containing all orders changed during the transfer period. This field has been deprecated, please ignore it.
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).
reportDateString, only included in response
Date on which this transfer report was created. This will typically be a few days before you receive the funds in your bank account
settlementCurrencyString, only included in the response
The ISO currency code of the currency you will be settled in in. A list of ISO currency codes can be foundhere
transferDateString, only included in response
The date on which the money was settled into your account.
transferDetailsJSON, only included in response
The individual line items of your transfer report.
paymentsSettledJSON, only included in response
The orders that were settled during this transfer period.
modificationDateString, only included in response
The date on which this order was settled.
orderCodeString, only included in response
A WorldPay generated unique order code. This order code will be referred to in all of our reports.
customerOrderCodeString, only included in response
The code or ID under which this order is known in your systems.
cardTypeString, only included in response
Type of the card that was used. Refer to the Card Types listed in the Order API section for supported card types (introduction section, below the JSON)
currencyCodeString, only included in response
The ISO currency code of the currency you want to charge your customer in. A list of ISO currency codes can be foundhere
currencyCodeExponentString, 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
amountInteger, only included in response
The amount to be charged in cents (or whatever the smallest unit is of the currencyCode that you specified, see currencyCodeExponent below). Always shown as positive.
exchangeRateString, only included in response
The exchange rate used in case the currencyCode was different from the settlementCurrency
commissionInteger, only included in response
The amount that will be deducted as fees in cents
netAmountInteger, only included in response
Merchant detail view of the amount that will be settled to you after commissions have been deducted in cents, typically shows as a positive value for orders, refund of charges etc., and negative for Refunds, Chargebacks, fees etc.
paymentChargeBacksJSON, only included in response
The orders that were charged back during this transfer period. If a payment was both settled and charged back during this transfer period, it will show in both the "paymentsSettled" and the "paymentChargeBacks" lists. Note all the fields of this object are the same as the fields of the "paymentsSettled" object, see above.
paymentReverseChargeBacksJSON, only included in response
The orders for which the charge back was reversed during this transfer period. If a payment was both charged back and reverse charged back during this transfer period, it will show in both the "paymentChargeBacks" and the "paymentReverseChargeBacks" lists. Note: all the fields of this object are the same as the fields of the "paymentsSettled" object, see above.
paymentRefundsJSON, only included in response
The orders that were refunded during this transfer period. If a payment was both settled and refunded during this transfer period, it will show in both the "paymentsSettled" and the "paymentRefunds" lists. Note: all the fields of this object are the same as the fields of the "paymentsSettled" object, see above.
miscellaneousDetailsJSON, only included in response
Transfer report line items not directly related to orders, e.g. invoices or incorrect charges.
descriptionString, only included in response
Description of the transfer item.
settlementCurrencyString, only included in the response
The ISO currency code of the currency you will be settled in in. A list of ISO currency codes can be foundhere
settlementCurrencyExponentString, only included in the response
The number of decimals after the dot for this currency. The value will be 2 for most currencies but can sometimes be 3
depositCorrectionDetailJSON, only included in response
A deposit you made into your account. The amount will be negative reflecting that this is a credit into your account. Note: all the fields of this object are the same as the fields of the "miscellaneousDetails" object, see above.
transferNetAmountInteger, only included in response
Worldpay view of the amount credited to your merchant account and debited from Worldpay account, hence typically shows as a negative value.
transferAmountCurrencyCodeInteger, only included in response
The ISO currency code of the currency you will be settled in.
transferAmountCurrencyCodeExponentInteger, 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.