Bank Transfer
| Payment method's type | Bank transfer |
| Country | Pakistan |
| Currency | PKR |
The Bank Transfer payment method supports payouts only. To initiate a payout to a customer's bank account, add the following parameters to your request:
| Parameter | Type | Required | Description |
|---|---|---|---|
merchantId | integer | Required | Your unique merchant ID that you got from Amanpay when integrating. |
paymentId | string | Required | Payment ID unique within your system. |
amount | number | Required | Payout amount in major currency units, e.g., pass 10.52 for 10 dollars 52 cents or 11.00 for 11 dollars. |
currency | string | Required | Code of the payout currency in the ISO-4217 alpha-3 format. |
customerId | string | Optional | Customer's ID unique within your system. If not passed in the request, the value from the customerEmail parameter is used. |
customerEmail | string | Required | Customer's email. |
customerName | string | Required | Customer's full name. |
paymentMethod | string | Required | Payment method's code. Pass banktransfer in this parameter. |
recipientType | string | Required | Recipient account type. Pass bank_account in this parameter. |
bankCode | string | Required | Recipient bank code. See the Bank codes. |
recipientBankAccNumber | string | Required | Recipient's bank account number. |
You can also add any optional parameters described in the Create a payout request section to your request.
Here is an example of a request to initiate a payout with the Bank Transfer payment method.
curl -X POST "https://gateway.amanpay.io/payments/payouts/initiate" \
-H "Content-Type: application/json" \
-H "Authorization: b78d07bc3e51899182339bfb39c85ab8629085c80f9b2312444669a3bdd78cc0522a1bcca50ede6be3a90fcf489100304cde09e14fa51a175a5fed0e36f6c26b" \
-d '{
"merchantId": 8213,
"paymentId": "ORDER_100001_{{$randomInt}}_{{$randomInt}}",
"amount": 1.00,
"currency": "PKR",
"customerId": "customer174",
"customerEmail": "mark_cooper@example.com",
"customerName": "Mark Cooper",
"paymentMethod": "banktransfer",
"recipientType": "bank_account",
"bankCode": "MEEZAN",
"recipientBankAccNumber": "PXXXXXXXXXXXXXXXXXXXX"
}'