Access Worldpay
/
Payouts

Payouts (4)

Download OpenAPI specification:Download

Payouts root resource, returns links to available payouts actions.

Servers

testing (try)

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

live

https://access.worldpay.com/

Retrieve payout details

Retrieve the details of an existing Basic Disbursement or Fast Access Payout.

SecurityHTTP: BasicAuth
Request
path Parameters
resource
required
string

original resource

get
/payouts/{resource}
Request samples
Responses
200
Payout resource.
Response Schema: application/vnd.worldpay.payouts-v4+json
outcome
required
string 
outcome of payouts request
 
receivedAt
required
string 
A timestamp of receivedAt
 
Response samples
application/vnd.worldpay.payouts-v4+json
Basic Disbursement: Successful resource retrieval with outcome requestReceived
{
"outcome": "requestReceived",
"receivedAt": "2023-09-01T10:37:36.923Z",
"_links": {
"payouts:payout": {
"href": "https://try.access.worldpay.com/payouts/{resource}"
},
"curies": [
{
"name": "payouts",
"href": "https://try.access.worldpay.com/rels/payouts/{rel}",
"templated": true
}
]
}
}
Retrieve the payout details of a historic resource.
Query by transaction reference and entity to retrieve a Payout.
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
/payouts/query
Request samples
Responses
200
Returns a payout resource, provided one matches the transaction and entity references.
Response Schema: application/vnd.worldpay.payouts-v4+json
outcome
required
string 
outcome of payouts query request
 
receivedAt
required
string 
A timestamp of receivedAt
 
Response samples
application/vnd.worldpay.payouts-v4+json
Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'
{
"outcome": "requestReceived",
"receivedAt": "2018-09-01T10:37:36.923Z",
"_links": {
"payouts:payout": {
"href": "https://try.access.worldpay.com/payouts/{resource}"
},
"curies": [
{
"name": "payouts",
"href": "https://try.access.worldpay.com/rels/payouts/{rel}",
"templated": true
}
]
}
}
Disburses funds to the payout instrument specified.
Disburse funds to a payout instrument.
SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.payouts-v4+json
required
object 
An object that contains all the information related to your payout request.
 
required
object 
An object that contains information about the merchant.
 
transactionReference
required
string 
A unique reference generated by you, used to identify a payout throughout its lifecycle.
 
post
/payouts/basicDisbursement
Request samples
application/vnd.worldpay.payouts-v4+json
Successful Basic Disbursement
{
"merchant": {
"entity": "default"
},
"instruction": {
"value": {
"amount": 300,
"currency": "GBP"
},
"payoutInstrument": {
"type": "card/plain",
"cardHolderName": "Mr Arjen Lucassen",
"cardExpiryDate": {
"month": 1,
"year": 2025
},
"cardNumber": "4444333322221111",
"billingAddress": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"postalCode": "postalCode",
"city": "city",
"state": "state",
"countryCode": "GB"
}
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
}
},
"transactionReference": "transaction-ref"
}
Responses
201
Funds have been disbursed or queued for disbursal successfully.
Response samples
application/vnd.worldpay.payouts-v4+json
Successful Basic Disbursement
{
"outcome": "requestReceived",
"receivedAt": "2018-09-01T10:37:36.923Z",
"_links": {
"payouts:payout": {
"href": "https://try.access.worldpay.com/payouts/{resource}"
},
"curies": [
{
"name": "payouts",
"href": "https://try.access.worldpay.com/rels/payouts/{rel}",
"templated": true
}
]
}
}
Disburses funds to the payout instrument specified.
Disburse funds to a payout instrument using fastAccess.
SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.payouts-v4+json
required
object 
An object that contains all the information related to your payout request.
 
required
object 
An object that contains information about the merchant.
 
transactionReference
required
string 
A unique reference generated by you, used to identify a payout throughout its lifecycle.
 
post
/payouts/fastAccess
Request samples
application/vnd.worldpay.payouts-v4+json
Successful issuing of a disbursal request
{
"merchant": {
"entity": "default"
},
"instruction": {
"value": {
"amount": 300,
"currency": "GBP"
},
"payoutInstrument": {
"type": "card/plain",
"cardHolderName": "Mr Arjen Lucassen",
"cardExpiryDate": {
"month": 1,
"year": 2025
},
"cardNumber": "4444333322221111",
"billingAddress": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"postalCode": "postalCode",
"city": "city",
"state": "state",
"countryCode": "GB"
}
},
"narrative": {
"line1": "STATEMENT",
"line2": "OPTIONAL"
}
},
"transactionReference": "transaction-ref"
}
Responses
201
Funds have been disbursed or queued for disbursal successfully.
Response samples
application/vnd.worldpay.payouts-v4+json
Successful issuing of a disbursal request
{
"outcome": "pending",
"receivedAt": "2018-09-01T10:37:36.923Z",
"_links": {
"payouts:payout": {
"href": "https://try.access.worldpay.com/payouts/{resource}"
},
"curies": [
{
"name": "payouts",
"href": "https://try.access.worldpay.com/rels/payouts/{rel}",
"templated": true
}
]
}
}