Create a payout
Changed onSend money to your customers.
Request
- Base URLhttps://sandbox.comcarde.com/v1
- URLhttps://sandbox.comcarde.com/v1/payouts
- AuthHTTP bearer
Request body
Example request
{
"psp": "Checkout.com",
"amount": 1234,
"currencyCode": "GBP",
"recipient": {
"title": "Mrs",
"firstName": "John",
"lastName": "Smith",
"ipAddress": "123.100.100.200",
"customerId": "Customer001",
"documentIssuer": "GB",
"documentId": "ABC-123456",
"documentType": "DNI",
"email": "john.smith@example.com",
"gender": "male",
"dateOfBirth": "2024-02-24",
"address": {
"buildingNumberOrName": "10a",
"address1": "Flat 1",
"address2": "Victoria House",
"address3": "15 Apple Street",
"town": "Edinburgh",
"county": "Lothian",
"postcode": "BH23 6AA",
"country": "GB",
"countrySubdivisionCode": "WY"
},
"phoneNumber": "+44 123 1110000"
},
"paymentInstrument": {
"bankDetails": {
"bankDetailsFormat": "GB",
"iban": "GB32CLRB04066800012315",
"swiftBic": "HBUKGB4B",
"bankName": "A Bank"
}
},
"reference": "abc123",
"purpose": "leisure",
"customerId": "Customer001",
"cashierId": "90e7aff7-7e57-459a-a46e-9258c8abc99b",
"merchantTransactionId": "yourUniqueRequestId",
"customMetadata": {
"accountAge": "2",
"transactionType": "Other"
}
}Response
Payout request completed successfully.
Example response
{
"code": "1000",
"id": "a7f45953-1e8b-4f33-87b0-3293f4f6972f",
"paymentId": "57f7f444-29ce-4230-8c7f-1c1fd85c8bc9",
"psp": {
"name": "Checkout.com",
"transactionId": "6418da68-0b3d-4409-ab14-1ceb752b0b1f",
"switchAccountId": "switch-account-123",
"provisionedUserId": "Vx0H4pdAtPCz",
"additionalInfo": {
"customerFirstName": "John",
"customerLastName": "Smith",
"customerDateOfBirth": "2000-01-01",
"customerIpAddress": "123.100.100.200",
"customerId": "de5d7b4a-9410-40e1-85fd-8ceee23c9fd0",
"paysafecardCustomerId": "151743187547"
},
"rawPspResponses": [
{
"httpStatusCode": 200,
"pspName": "Checkout.com",
"headers": {
"content-type": [
"application/json"
]
}
}
]
},
"action": {
"type": "3D_SECURE",
"paymentId": "57f7f444-29ce-4230-8c7f-1c1fd85c8bc9"
},
"actionRequired": true,
"merchantTransactionId": "yourUniqueRequestId",
"riskAssessments": {
"merchant": {
"decision": "APPROVED",
"retryable": true,
"rawResponse": {
"httpStatusCode": 200
}
}
},
"paymentInstrument": {
"account": {
"accountId": "customer@email.com"
}
},
"amount": 1234,
"currencyCode": "GBP"
}Changes
- breaking
added the new required request property
///// - breaking
added the new required request property
///// - breaking
added the new required request property
///// - breaking
added the new required request property
///// - breaking
added to the
//request propertyallOflist - breaking
added to the
request propertyallOflist - breaking
the request property
/////became required - breaking
the request property
/////became required - breaking
the
/////request property's minLength was increased from0to1 - breaking
removed from the
//request propertyoneOflist - breaking
the
////request property type changed from no type toobject - breaking
the
//request property type changed fromobjectto no type - breaking
the
request property type changed fromstringto no type - breaking
the
/request property type changed from no type toobject - breaking
the response's body type changed from
objectto no type for status - breaking
the response's body type changed from
objectto no type for status - breaking
the response's body type changed from
objectto no type for status - breaking
the
response's property type changed from no type toobjectfor status - breaking
the
response's property type changed from no type toobjectfor status - breaking
the
////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
//////////response's property format changed fromipv4to no format for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
/response's property type changed fromstringto no type for status - breaking
the
//////response's property format changed fromipv4to no format for status - breaking
the
//////response's property format changed fromipv4to no format for status - warning
removed
subschema #2from the/request propertyallOflist - warning
removed
subschema #2from the////request propertyallOflist - warning
the
/////request property's maxLength was set to200 - warning
changed the pattern of the request property
/////from^[a-zA-Z0-9 ]+$to^[a-zA-Z0-9 .-]+$ - warning
changed the pattern of the request property
/from^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$to^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$ - warning
removed the request property
///// - warning
removed the request property
///// - warning
removed the request property
///// - warning
removed the request property
///// - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
added the new optional request property
///// - info
added the new optional request property
///// - info
added the new optional request property
///// - info
added the new optional request property
///// - info
added the new optional request property
///// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new optional request property
// - info
removed discriminator from
//request property - info
removed the pattern
^[A-Za-z0-9\- ().]*$from the request property - info
the
/request property format was generalized fromipv4to no format - info
added
subschema #2to the response bodyallOflist for the response status - info
added
subschema #2to the response bodyallOflist for the response status - info
added
subschema #2to the response bodyallOflist for the response status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added to the
/response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
added
subschema #2to the////response propertyallOflist for the response status - info
the response property
//////////became required for the status - info
the response property
//////////became required for the status - info
the response property
//////////became required for the status - info
the response property
//////////became required for the status - info
the response property
//////////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
the response property
//////became required for the status - info
removed discriminator from
response property for the response status - info
removed discriminator from
response property for the response status - info
removed discriminator from
////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the/////response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the//response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
FAST_FUNDSenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/////response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the//response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
NOT_SUPPORTEDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the/////response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the//response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
STANDARDenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the/////response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the//response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed the
UNKNOWNenum value from the/response property for the response status - info
removed from the
response propertyoneOflist for the response status - info
removed from the
response propertyoneOflist for the response status - info
removed from the
////response propertyoneOflist for the response status - info
the
//////////response's property pattern was changed from^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$to^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$for the status - info
the
//////response's property pattern was changed from^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$to^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$for the status - info
the
//////response's property pattern was changed from^$|^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$to^$|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::(ffff(:0{1,4})?:)?((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))$for the status
- breaking