Skip to main content

Requests (requests)

TIn this manual, we are going to walk you through the requests parameter, which comprises an array of beneficiary objects associated with a batch. Each object contains detailed beneficiary information necessary for processing individual payouts, offering flexibility and comprehensive data for each transaction.

Be Aware Off

Kindly be aware that the requests parameter is one of the required parameters to initiate the you will be using while creating a batch as clarified in orCreate Batch APIManual.

Parameter Specifications​

The Parameter Keyrequests
Data TypeArray of Objects
Description
Array of beneficiaries objects.
Requiredβœ”
Sample
"requests": [
{
"merchant_reference":"1234",
"amount": 101,
"beneficiary_name": "Technical Support",
"beneficiary_country": "SA",
"beneficiary_account_number": "SE3550000000054910000003",
"beneficiary_bank": "ESSESESS",
"beneficiary_bank_branch": "",
"beneficiary_email": "[email protected]",
"beneficiary_mobile_number": "+(966) 55 xxxxxx6",
"beneficiary_address1": "Riyadh",
"beneficiary_address2": "",
"transfer_code": 100,
"source_name": "PayTabs KSA",
"source_address1": "address1",
"source_address2": "address2",
"source_address3": "address3"
},
{
"merchant_reference":"5678",
"amount": 155,
"beneficiary_name": "[email protected]",
"beneficiary_country": "SA",
"beneficiary_account_number": "SE3550000000054910000003",
"beneficiary_bank": "ESSESESS",
"beneficiary_bank_branch": "",
"beneficiary_email": "[email protected]",
"beneficiary_mobile_number": "+(966) 55 xxxxxx6",
"beneficiary_address1": "Riyadh",
"beneficiary_address2": "",
"transfer_code": 101,
"source_name": "PayTabs KSA",
"source_address1": "address1",
"source_address2": "address2",
"source_address3": "address3"
}
]
Parameter
Data Type
Required
Min
Max
merchant_reference
string
βœ”
-
50
Merchant reference for the transaction.
merchant_reference2
string
❌
-
50
Merchant reference for the transaction.
merchant_reference3
string
❌
-
50
Merchant reference for the transaction.
amount
string
βœ”
-
18
Payout amount for the request.
beneficiary_name
string
βœ”
-
50
Name of the beneficiary.
beneficiary_country
string
βœ”
-
-
ISO (Alpha-2/ A-2 ) Country Code of the beneficiary.
beneficiary_account_number
string
βœ”
-
50
IBAN Account number of the beneficiary.
beneficiary_bank
string
βœ”
-
50
Name of the beneficiary's bank.
beneficiary_bank_branch
string
βœ”
-
50
Branch of the beneficiary's bank.
beneficiary_email
string
βœ”
-
-
Email address of the beneficiary.
beneficiary_mobile_number
string
βœ”
-
-
Mobile number of the beneficiary with county code prepended +(code)( phone number )
beneficiary_address1
string
βœ”
-
50
Address line 1 of the beneficiary.
beneficiary_address2
string
❌
-
50
Address line 2 of the beneficiary.
source_name
string
βœ”
-
64
Name of the source.
source_address1
string
βœ”
-
64
Address line 1 of the source.
source_address2
string
❌
-
64
Address line 2 of the source.
source_address3
string
❌
-
64
Address line 3 of the source.
transfer_code
integer
βœ”
-
-
Transfer code for the request.


We are glad to be always in help. We aim to serve you better each time. As such, please spare a minute to share feedback about your recent experience with PayTabs Developers , on Trustpilot, or Google Reviews.