Payout (Sender as Account Information)
Global and Local Payout
Send money to 154 countries in the world
POST METHOD
{{baseUrl}}/api/v2/transaction/remittance
{
"email":null,
"beneficiaryId":70,
"debitAmount":3,
"debitCur":"USD",
"creditCur":"USD",
"remittancePurpose":"7-BUSINESS",
"fundSource":"7-BUSINESS",
"extension": null,
"remittancePurposeFile": null,
"securityQuestion" : null,
"securityAnswer" : null,
"category": "BANK",
"option": null,
}
| Field | Required | Data Type | Description |
|---|---|---|---|
| false | Sub-User email address (required if the transaction will be initiated by sub user account | ||
| beneficiaryId | true | Integer | ID of the beneficiary details to send fund to |
| debitAmount | true | decimal | Amount debited from wallet sending from |
| debitCur | true | String | Wallet to be debited. Length: 3, Currency ISO code i.e USD. |
| creditCur | true | String | Currency of the beneficiary to be credited. Length: 3, Currency ISO code i.e USD. |
| narration | true | String | Description on reason sending the fund |
| remittancePurpose | true | String | Remittance Id and Remittance Name from Payout Purpose . Example "7-BUSINESS" |
| fundSource | true | String | Fund Source Id and Name from [Fund Source] (https://docs.qwid.io/docs/source-of-funds) page. Example "7-BUSINESS" |
| remittancePurposeFile | false | String (base64 encoded) | Receipt generated for sending the fund, required for some amount of Transaction. |
| extension | false | String | Extension file to the base64 encoded file of remittancePurposeFile. It requires when remittancePurposeFile is set. |
| securityQuestion | false | String | Requires when category INTERAC. No special characters are valid. |
| securityAnswer | false | String | Requires when category INTERAC. No special character including whitespace is valid. |
| category | true | String | Check Category for list of valid payment categories |
| option | false | String | Required based on category options, check Option page to check list of options. |
Response
{
"status": true,
"content": {
"data": {
"transId": "blqtrans1709515033",
"transType": "Remittance",
"transRef": "blqtrans1709515033",
"purpose": "Remittance Transaction",
"desc": "Remittance of 3.00 USD => 3.00 USD, charges => 0.00",
"fromCur": "USD",
"toCur": "USD",
"fromAmount": "3",
"toAmount": "3",
"charges": "0",
"rate": "1",
"externalType": "Beneficiary",
"externalName": "Silvergate Bank( Blinqpay Corp - 0058****** )",
"externalId": 70,
"partnerAddon": "0",
"partnerAmountAddon": 0,
"remittance": null,
"remittancePurpose": "7-BUSINESS",
"remittancePurposeFile": null,
"fundSource": "7-BUSINESS",
"confirmation": "Payment Confirmed",
"status": "Pending",
"created_at": "2024-03-04T01:17:14.000000Z",
"updated_at": "2024-03-04T01:17:14.000000Z",
"reason": null,
"batchReference": null,
"incareOf": null
}
}
}
Updated 11 months ago