Submit Payment Request

post

https://sandbox.api.yellowcard.io/business/payments

Submit a disbursement payment request. This will lock in a rate and await approval.

Body Params

channelId

string

required

The identifier of the specific channel to execute payment through

sequenceId

string

required

Represents a unique id for the transaction from your end

amount

int32

Amount in USD to transact

localAmount

int32

The amount in local currency to transact

reason

string

required

The reason for the withdrawal

sender

object

required

Sender KYC details

destination

object

required

Destination and Recipient Details

forceAccept

boolean

enum

required

Defaults to false

Specify whether or not you want to skip the accept payment step

Allowed:

customerType

string

enum

required

Defaults to retail

Determines the type of validation that is performed on the sender. If value is institution, the sender request object will be validated to ensure it includes businessName and businessId parameter. If the value is retail, the sender request object will be validated to ensure it includes name, phone, email, country, address, dob, idNumber and idType.

Allowed:

customerUID

string

required

Unique identifier for the customer

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400