Transfer API (v1)

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Account APIs, unless you are using client certificate authenticating with SSL/TLS.

Accept Header

  Accept: application/vnd.worldpay.accounts.transfer-v1+json

We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.

DNS Whitelisting
Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License Worldpay
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Transfer funds

Request

Transfer funds between your accounts.

Headers
WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
Body
sourceAccountNumberstring

The 16-digit transfer source account number.

targetAccountNumberstring

A 16-digit transfer destination account number.

amountnumber(double)

A decimal value for the transfer. Currency is defined by the source account currency.

narrativestring

A description about the transfer.

quoteIdstring

The ID of the quote of an exchange rate for the transfer. Not currently used - can set as empty guid value (all zeros).

Transfer money between accounts.

{
  "sourceAccountNumber": "1111550000000001",
  "targetAccountNumber": "1111550000000002",
  "amount": 123.45,
  "narrative": "CurrencyTransfer12",
  "quoteID": "Q0000000BV"
}

Responses

Accepted

Body
object
Response
{}