Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.
Access Worldpay
/
Push funds to an eligible card.

Money Transfers (1)

MoneyTransfers root resource, returns links to available money transfers actions

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.

line1stringrequired

First line of text that appears on your customer's statement.

line2string

Second line of text that appears on your customer's statement.

recipientobjectrequired

Recipient details.

paymentInstrumentanyrequired

An object that contains your customer's paymentInstrument type.

firstNamestring

customer's firstName.

lastNamestring

customer's lastName.

senderobjectrequired

Sender details.

fundReferencestringrequired

Specifies a reference to the Origin account of the funds.

fundTypestringrequired

Specifies the type of funds being used by the sender in the transaction.

valueobjectrequired

An object that contains moneyTransfers amount and currency.

amountintegerrequired

The moneyTransfers amount.

currencystringrequired

The 3 digit currency code.

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