Payout
The request sends (pushes) funds to the recipient's card account.
Info
Your acquiring bank might impose limits and restrictions on using this transaction type. For details, contact your manager.
Request
To initiate a payout transaction, send a POST
request to https://gateway.pay-cross.com/transactions/payouts
with the following parameters:
Note
The request body must be wrapped in a top-level request{} object.
|
Example of the request
{
"request": {
"amount": 100,
"currency": "USD",
"description": "Test transaction ütf",
"tracking_id": "tracking_id_000",
"recipient": {
"ip": "127.0.0.1",
"email": "[email protected]",
"birth_date": "1990-10-20"
},
"sender": {
"ip": "127.0.0.1",
"email": "[email protected]",
"birth_date": "1990-10-20"
},
"recipient_billing_address": {
"first_name": "John",
"last_name": "Doe",
"country": "US",
"city": "Denver",
"state": "CO",
"zip": "96002",
"address": "1st Street",
"phone": "375444444444"
},
"sender_billing_address": {
"first_name": "John",
"last_name": "Doe",
"country": "US",
"city": "Denver",
"state": "CO",
"zip": "96002",
"address": "1st Street",
"phone": "375444444444"
},
"recipient_credit_card": {
"number": "5555555555554444",
"holder": "John Doe",
"exp_month": "12",
"exp_year": "2027"
},
"additional_data": {
"document": {
"type": "PASSPORT",
"issuer": "Organization name",
"series": "MP",
"number": "1234567890",
"issued_at": "2010-03-12",
"valid_until": "2025-03-12"
},
"contract": ["card_on_file"]
}
}
}
Example of the request with card token
{
"request": {
"amount": 100,
"currency": "USD",
"description": "Test transaction ütf",
"tracking_id": "tracking_id_000",
"recipient": {
"ip": "127.0.0.1",
"email": "[email protected]",
"birth_date": "1990-10-20"
},
"sender": {
"ip": "127.0.0.1",
"email": "[email protected]",
"birth_date": "1990-10-20"
},
"recipient_billing_address": {
"first_name": "John",
"last_name": "Doe",
"country": "US",
"city": "Denver",
"state": "CO",
"zip": "96002",
"address": "1st Street",
"phone": "375444444444"
},
"sender_billing_address": {
"first_name": "John",
"last_name": "Doe",
"country": "US",
"city": "Denver",
"state": "CO",
"zip": "96002",
"address": "1st Street",
"phone": "375444444444"
},
"recipient_credit_card": {
"token": "b4469f38-cec7-4f55-a86d-2ab2dc300e0b"
},
"additional_data": {
"document": {
"type": "PASSPORT",
"issuer": "Organization name",
"series": "MP",
"number": "1234567890",
"issued_at": "2024-03-12",
"valid_until": "2027-03-12"
}
}
}
}
Example of the OCT request for SH integration option
{
"request": {
"amount": 100,
"currency": "USD",
"description": "Test transaction ütf",
"tracking_id": "tracking_id_000",
"recipient": {
"ip": "127.0.0.1"
},
"sender": {
"birth_date": "1990-10-20" //Required
},
"recipient_billing_address": {
"first_name": "John", //Required
"last_name": "Doe", //Required
"country": "US", //Required if the recipient's country is Canada (CA), USA (US),
//Colombia (CO) or Nicaragua (NI)
"city": "Denver", //Required if the recipient's country is Canada (CA), USA (US),
//Colombia (CO) or Nicaragua (NI)
"state": "CO", //Required if the recipient's country is Canada (CA) or USA (US)
"address": "1st Street", //Required if the recipient's country is Canada (CA), USA (US),
//Colombia (CO) or Nicaragua (NI)
},
"sender_billing_address": {//Sender's data, the object is required if sender ≠ recipient
"first_name": "John",
"last_name": "Doe",
"address": "1 First Str.",
"country": "US",
"city": "Denver",
"state": "CO",//Only for US and CA
},
"recipient_credit_card": {
"number": "5555555555554444",
"exp_month": "12",
"exp_year": "2027"
},
"additional_data": {
"funding_type": "01" //Optional
}
}
}
Response
In the transaction section response parameters replicate request parameters except the additional ones:
|
Example of the response
{
"uid": "8f2b4e0e-b6e6-41d7-970a-5a506519aa0c",
"code": "S.0000",
"friendly_message": "The operation is successful.",
"status": "successful",
"amount": 100,
"currency": "USD",
"description": "Test transaction ütf",
"type": "payout",
"tracking_id": "tracking_id_000",
"message": "Successfully processed",
"test": true,
"created_at": "2024-04-02T14:57:57.638Z",
"updated_at": "2024-04-02T14:58:04.211Z",
"paid_at": "2024-04-02T14:58:04.172Z",
"manually_corrected_at": null,
"language": "en",
"redirect_url": "https://gateway.pay-cross.com/process/8f2b4e0e-b6e6-41d7-970a-5a506519aa0c",
"status_code": null,
"customer": {
"ip": "127.0.0.1",
"email": "[email protected]",
"device_id": null,
"birth_date": "1990-10-20",
"first_name": "John",
"last_name": "Doe",
"address": "1st Street",
"country": "US",
"city": "Denver",
"zip": "96002",
"state": "CO",
"phone": "375444444444"
},
"recipient": {
"customer": {
"first_name": "John",
"last_name": "Doe",
"address": "1st Street",
"country": "US",
"city": "Denver",
"zip": "96002",
"state": "CO",
"phone": "375444444444"
},
"payment_method": {
"holder": null,
"stamp": "b3839d334ba40e89168d60cd9f9d1390aee3fe67dd4d5c41adbf3998043eaef8",
"brand": "visa",
"last_4": "0000",
"first_1": "4",
"bin": "420000",
"bin_8": "42000000",
"issuer_country": "US",
"issuer_name": "VISA Demo Bank",
"product": "F",
"exp_month": null,
"exp_year": null,
"token_provider": null,
"token": null,
"type": "credit_card"
}
},
"links": {
"receipt_url": "https://admin.pay-cross.com/customer/transactions/8f2b4e0e-b6e6-41d7-970a-5a506519aa0c/ef2a8781b3f5de417df0826fc8e371ffd621134b81435f8e2ab02d7123055a89?language=en"
},
"smart_routing_verification": {
"status": "successful"
},
"transaction": {
"auth_code": "654321",
"bank_code": "00",
"rrn": "123456789102",
"ref_id": "777888",
"message": "Payout was approved",
"amount": 100,
"currency": "USD",
"billing_descriptor": "test descriptor",
"gateway_id": 3483,
"status": "successful"
}
}