API Reference
GuidesAPI Reference

Create Payments

post
https://sandbox-api.getbrass.co/banking/payments

Creates a new payable

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Title of the payment; it will also be used as the memo for the transfer (max: 80 chars)

string

A long description for the payment that clearly describes its purpose to your approvers

int32
required

The amount to be paid in lower units; e.g. NGN 1 = 100

string

Resource id of the account to be debited for the payment

string

Resource id of the contact to make the payment to. You can also specify the recipient inline using the "to" parameter

to
object

Inline recipient for the payment

string
enum
Defaults to pending

The preferred initial state for the payment

Allowed:
date

To create a scheduled payment, you should send a DateTime here in format: YYYY-MM-DDTHH:mm:SS e.g. 2021-12-31T13:58:00

tags
array of strings

Array of strings which are the resource ids of the tags to classify this payable as

tags
attachments
array of objects

Zero or more attachments to be added to the payable

attachments
string

A unique string that can be used to identify this payment from your side

int32

The custom hold-off time in minutes to be applied to the payment after it has been approved

Headers
string
required
Defaults to Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhdXRoLmdldGJyYXNzLmNvIiwiZXhwIjoxNjA4OTg4NTI0LCJpYXQiOjE2MDg5ODQ5MjQsIm5iZiI6MTYwODk4NDkyNCwiYXBpX2NsaWVudCI6ImFwcF82OEQ0eTJ3d1V0aENNV3BrTXZ5WjRZIiwiY3VzdG9tZXIiOiJjdXNfN0x0NWpIeXFmd3pXc1M1dVM5aFA1MiIsInVzZXIiOiJ1c3JfNE0xNTJVTWlMR05DYTE1cFlUQXZDcCJ9.spCnJ6iokwFMyt8MPZZ7CyFpLKW01EXHYLOYLb5URt55OS91-66xEl4ktySKgZwitXlf5W2WHrQmb8_lQx_F7S7uAIkv4gcmYC-Bu45IsADtQVQXyGJAyu-4-tGV5pxEKOxW5lr-XhtujSxTMM-OPkaz2lJFG9wX61uR0hnErcY

An auth level 2 token to authorize the call

Response

Updated about 5 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 years ago