Skip to main content
Initiate a payout. When you call this endpoint, Reeple transfers the funds from your available balance and notifies your application through a webhook once the transfer completes — see Webhooks.

​
Endpoint

POST https://api-v3.reeple.ai/transfer

​
Request body

FieldTypeDescription
accountNumberStringRequired. The recipient’s bank account number.
amountNumber >= 1Required. Amount to pay out.
bankCodeStringRequired. Code identifying the recipient’s bank (routing number / BIC).
currencyStringRequired. See Currency support.
narrationStringRequired. Description of the transfer, shown on the recipient’s bank statement.
accountNameStringThe recipient’s account name.
bankNameStringThe destination bank’s name.
metaObjectAdditional information about the transfer.
referenceStringYour unique reference for this payout.
saveBeneficiaryBoolean, default falseWhether to save the recipient for future transfers.
saveBeneficiaryTagStringName to assign the saved beneficiary, if saveBeneficiary is true.
accountTypeEnumFor USD transfers: CHECKING | SAVINGS. For AUD transfers, add accountType: "BSB" inside meta.
beneficiaryTypeEnumINDIVIDUAL | BUSINESS.

​
NGN transfer example

{
  "currency": "NGN",
  "bankName": "string",
  "bankCode": "string",
  "accountNumber": "string",
  "accountName": "string",
  "amount": 1,
  "narration": "string",
  "meta": {},
  "saveBeneficiary": false,
  "saveBeneficiaryTag": "string",
  "reference": "string"
}

​
AUD transfer example

{
  "type": "BSB",
  "currency": "AUD",
  "country": "AU",
  "accountNumber": "string",
  "accountName": "string",
  "amount": 10,
  "narration": "string",
  "meta": {
    "accountType": "BSB",
    "bsbNumber": "string"
  },
  "saveBeneficiary": false,
  "saveBeneficiaryTag": "string",
  "reference": "string"
}

​
USD transfer example

{
  "type": "ACH",
  "currency": "USD",
  "country": "US",
  "accountNumber": "string",
  "accountName": "string",
  "bankName": "string",
  "amount": 10,
  "narration": "string",
  "meta": {
    "routingNumber": "string",
    "accountType": "ACH",
    "postCode": "string",
    "city": "string",
    "state": "string",
    "line1": "bank address",
    "bankAddress": "string",
    "beneficiary": {
      "type": "INDIVIDUAL",
      "country": "beneficiary country",
      "state": "beneficiary state",
      "city": "beneficiary city",
      "postCode": "beneficiary postCode",
      "line1": "beneficiary address",
      "address": "beneficiary address"
    }
  },
  "saveBeneficiary": false,
  "saveBeneficiaryTag": "string",
  "reference": "string"
}

​
Response

{
  "success": true,
  "statusCode": 200,
  "message": "Transfer In Progress",
  "data": {}
}
A 500/502 error on this endpoint does not necessarily mean the payout failed — it can also mean the response was lost after Reeple already processed it. Verify the transaction before retrying to avoid paying out twice. See Errors.

​
Tracking a payout