Access Worldpay
/
Query for a money transfer using transactionReference and entity.

Money Transfers (1)

Authentication

Set your headers:

  Authorization: {your_credentials}
  Content-Type: application/vnd.worldpay.money-transfers-v1+json
  Accept: application/vnd.worldpay.money-transfers-v1+json

Replace {your_credentials} with your base64-encoded Basic Auth username and password.


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
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Push funds to an eligible card.

Request

Push funds to an eligible card.

Bodyapplication/vnd.worldpay.money-transfers-v1+json
instructionobjectrequired

An object that contains all the information related to your moneyTransfers request.

narrativeobjectrequired

An object that contains identification and further details of the merchant.

recipientobjectrequired

Recipient details.

senderobjectrequired

Sender details.

valueobjectrequired

An object that contains moneyTransfers amount and currency.

merchantobjectrequired

An object that contains information about the merchant.

entitystringrequired

This is mandatory for authentication and queries. Contact your Implementation Manager for more information.

transactionReferencestringrequired

A unique reference generated by you, used to identify a moneyTransfer throughout its lifecycle.

application/vnd.worldpay.money-transfers-v1+json

A pushToCard with all fields for a 'card/plain' paymentInstrument.

{
  "transactionReference": "transactionReference",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "narrative": {
      "line1": "line1",
      "line2": "line2"
    },
    "value": {
      "amount": 100,
      "currency": "GBP"
    },
    "recipient": {
      "firstName": "firstName",
      "lastName": "lastName",
      "paymentInstrument": {
        "type": "card/plain",
        "cardHolderName": "name",
        "cardNumber": "4444333322221111",
        "cardExpiryDate": {
          "month": 12,
          "year": 2040
        },
        "cvc": "123",
        "billingAddress": {
          "address1": "address1",
          "address2": "address2",
          "address3": "address3",
          "postalCode": "12345",
          "city": "city",
          "state": "state",
          "countryCode": "GB"
        }
      }
    },
    "sender": {
      "fundReference": "fundReference",
      "fundType": "nonStagedDigitalWallet"
    }
  }
}

Responses

A pushToCard has been performed successfully.

Bodyapplication/vnd.worldpay.money-transfers-v1+json
outcomestringrequired

outcome of moneyTransfers request

receivedAtstringrequired

A timestamp of receivedAt

typestringrequired
Response
application/vnd.worldpay.money-transfers-v1+json

A pushToCard with all fields for a 'card/plain' paymentInstrument.

{
  "outcome": "approved",
  "type": "pushToCard",
  "receivedAt": "2022-01-01T00:00:00Z",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/moneyTransfers/{resource}"
    }
  }
}

Query for a money transfer using transactionReference and entity.

Request

Query for a money transfer.

Query
transactionReferencestringrequired

A unique reference generated by you, used to identify a payout throughout its lifecycle

Example: transactionReference=12345
entitystringrequired

merchant entity

Example: entity=default
No request payload

Responses

A query by transactionReference and entity has been performed successfully.

Bodyapplication/vnd.worldpay.money-transfers-v1+json
outcomestringrequired

outcome of moneyTransfers request

receivedAtstringrequired

A timestamp of receivedAt

typestring
Response
application/vnd.worldpay.money-transfers-v1+json

A query for a pushToCard money transfer with an outcome of approved.

{
  "outcome": "approved",
  "type": "pushToCard",
  "receivedAt": "2022-01-01T00:00:00Z",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/moneyTransfers/{resource}"
    }
  }
}