Skip to main content
POST
/
billing
/
v1
/
disbursements
Request a Disbursement
curl --request POST \
  --url https://sandbox-api.payfonte.com/billing/v1/disbursements \
  --header 'Content-Type: application/json' \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>' \
  --data '
{
  "transferRecipientId": "6659692f019f6a143f7f90db",
  "amount": 100000,
  "reference": "<string>",
  "narration": "Transfer of 100",
  "pin": "<string>",
  "webhookURL": "https://example.com/webhook",
  "metadata": {
    "merchantName": "Karis Clothing",
    "trafficType": "ECOMMERCE"
  }
}
'
{
  "data": {
    "reference": "<string>",
    "amount": 100000,
    "amountPayable": 100000,
    "provider": "<string>",
    "currency": "USD, NGN, XOF, XAF",
    "country": "US, NG, CI, SN, CA, UK"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.payfonte.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
client-id
string
header
required
​
client-secret
string
header
required

Body

application/json

Request a Disbursement

​
transferRecipientId
string
required

id of a transfer recipient gotten from the response of TransferRecipient Call

Example:

"6659692f019f6a143f7f90db"

​
amount
integer<int64>
required

Amount should be in the subunit of the supported currency i.e value * 100 Amount Specification

Example:

100000

​
reference
string

A reference code you'll generate to identify this transaction. This must be unique for every transaction. If you don't pass one, we will generate one for you.

​
narration
string
Example:

"Transfer of 100"

​
pin
string

This is your disbursement pin. This is a form of disbursement authorization. Alternative is an Authorization URL

​
webhookURL
string<uri>

This is a URL, if this is passed we will send the event webhook payload to this endpoint. Use this to override the webhook url provided on the dashboard for this transaction. Read more on Webhooks

Example:

"https://example.com/webhook"

​
metadata
object

Response

201 - application/json

Request for Disbursement Successful

​
data
object