Skip to content
Passed

Transfers (2025-01-01)

Transfer funds from source account to target account.

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 Transfers API.

WP-Api-Version Header

  WP-Api-Version: 2025-01-01

We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.

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. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Try

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

Live

https://access.worldpay.com/

Transfer funds between your accounts.

Request

Transfer funds between your accounts.

Security
BasicAuth
Headers
WP-Api-Versionstringrequired

Represents the version of the API.

Example: 2025-01-01
WP-CorrelationIdstring

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

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-CallerIdstring

An ID used for logging purposes.

Default swagger
Acceptstring
Example: application/json
Bodyapplication/json
sourceAccountNumberstring= 16 charactersrequired

The source account number.

Example: "1111550000000001"
targetAccountNumberstring= 16 charactersrequired

The target account number.

Example: "1111550000000002"
amountnumber(double)required

The amount. A maximum of seven digits before the decimal place. A maximum of two decimal places.

Example: "77.22"
narrativestring[ 6 .. 34 ] characters^[a-zA-Z0-9\s-]required

You can use this to describe what the transfer is for.

Example: "A narrative"
quoteIdstring or null

The quoteId returned by the FX API.

Example: "QuoteId"
application/json
{
  "sourceAccountNumber": "1111550000000001",
  "targetAccountNumber": "1111550000000002",
  "amount": "77.22",
  "narrative": "A narrative",
  "quoteId": "QuoteId"
}

Responses

Accepted

Bodyapplication/json
object
Response
application/json
{}