Money Transfers (1)

Download OpenAPI specification:Download

MoneyTransfers root resource, returns links to available money transfers actions

Servers

testing (try)

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

live

https://access.worldpay.com/

Push funds to an eligible card.

Push funds to an eligible card.

SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.money-transfers-v1+json
required
object

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

required
object

An object that contains information about the merchant.

transactionReference
required
string

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

post
/moneyTransfers/pushToCard
Request samples
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

201

A pushToCard has been performed successfully.

Response samples
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.

Query for a money transfer.

SecurityHTTP: BasicAuth
Request
query Parameters
transactionReference
required
string

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

Example: transactionReference=12345
entity
required
string

merchant entity

Example: entity=default
get
/moneyTransfers/query
Request samples
Responses

200

A query by transactionReference and entity has been performed successfully.

Response Schema: application/vnd.worldpay.money-transfers-v1+json
outcome
required
string

outcome of moneyTransfers request

receivedAt
required
string

A timestamp of receivedAt

type
string
Response samples
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}" } } }