New payout request - Flashpay API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

amount

integer

required

currency

string

required

beneficiaryId

string

required

payoutTitle

string

required

idempotencyKey

string

required

payoutDate

string

required

Example

{
    "amount": 100000,
    "currency": "NGN",
    "beneficiaryId": "c52imk98q0njhm3zin2jjlvj",
    "payoutTitle": "example payout",
    "idempotencyKey": "hello-world",
    "payoutDate": "2024-06-26T14:11:40.206Z"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://example.com/api/v1/payout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100000,
    "currency": "NGN",
    "beneficiaryId": "c52imk98q0njhm3zin2jjlvj",
    "payoutTitle": "example payout",
    "idempotencyKey": "hello-world",
    "payoutDate": "2024-06-26T14:11:40.206Z"
}'

Responses

🟢201Created

application/json

Body

id

string

required

amount

integer

required

currency

string

required

status

string

required

beneficiaryId

string

required

payoutTitle

string

required

payoutDate

string

required

createdAt

string

required

updatedAt

null

required

beneficiary

object

required

id

string

required

bankId

string

required

accountName

string

required

accountNumber

string

required

currency

string

required

ownerId

string

required

defaultAccount

boolean

required

accountType

string

required

createdAt

string

required

updatedAt

null

required

Example

{
    "id": "zul8cwjrjdzt6u40e3lvlu7p",
    "amount": 100000,
    "currency": "NGN",
    "status": "OPEN",
    "beneficiaryId": "c52imk98q0njhm3zin2jjlvj",
    "payoutTitle": "example payout",
    "payoutDate": "2024-06-26T14:11:40.206Z",
    "createdAt": "2024-06-26T14:45:51.275Z",
    "updatedAt": null,
    "beneficiary": {
        "id": "c52imk98q0njhm3zin2jjlvj",
        "bankId": "dqv8ldz5mk4eu7ykcvrr8g84",
        "accountName": "Alphabets Inc",
        "accountNumber": "1234ABCXXX",
        "currency": "NGN",
        "ownerId": "k235v1ujhhnpwv0zmyk4by6t",
        "defaultAccount": true,
        "accountType": "personal",
        "createdAt": "2024-04-23T07:01:24.844Z",
        "updatedAt": null
    }
}