e-Mandate Enrollment
v2 POST
console.bayar.cash/api/v2/mandates
v3 POST
api.console.bayar.cash/v3/mandates
Initialize enrollment request to Bayarcash. Make sure your account is enabled for Direct Debit payment channel.
portal_key
Portal key retrieve from Bayarcash console
string
Required
order_number
string
Required
amount
integer
Required
payer_id_type
integer
Required
payer_id
integer
Required
payer_name
string
Required
payer_email
string
Required
payer_telephone_number
integer
Required
frequency_mode
string
Required
application_reason
string
Required
effective_date
Required
metadata
string
Optional
return_url
Callback data will be sent to this URL
string
Optional
success_url
string
Optional
failed_url
string
Optional
checksum
string
Optional
Example of sending POST
request with cURL.
curl -X POST https://api.console.bayar.cash/v3/mandates \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Personal_Access_Token>' \
--data-raw '{
"portal_key": string,
"order_number": DD001,
"amount": 100,
"payer_id_type": 1,
"payer_id": "123456121234",
"payer_name": "Mohd Ali",
"payer_email": "[email protected]",
"payer_telephone_number": "60191122000",
"frequency_mode": "MT",
"application_reason": "Enrollment for DD001",
"effective_date": "2024-08-01",
"expiry_date": "2025-07-01",
"metadata": string,
"return_url": "https://website.net/callback",
"success_url": "https://website.net/success",
"failed_url": "https://website.net/failed",
"checksum": string
}'
Example of JSON structured response.
{
"payer_name": "Mohd Ali",
"payer_id_type": 1,
"payer_id": "910109021234",
"payer_email": "[email protected]",
"payer_telephone_number": "60196019001",
"order_number": "DD001",
"amount": 30,
"application_type": "Enrollment",
"application_reason": "Enrollment of DD001",
"frequency_mode": "MT",
"effective_date": "2024-06-15",
"expiry_date": "2024-08-15",
"url": "https://console.bayar.cash/payment-intent/pi_pGwZaY"
}
Last updated