Submit Collection Request

post

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

Submit a collection 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

recipient

object

Recipient's KYC details

source

object

Source account details

forceAccept

boolean

Defaults to false

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

customerType

string

enum

required

Defaults to retail

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

Allowed:

redirectUrl

string

This is used to determine where the customer is redirected to after a transaction is initiated for channels that require redirect. This param is required if the selected channel requires redirect and forceAccept is set to true.

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

500500