v1

latestOpenAPI 3.1.02026-07-26460218.4 KB

Submit Receive Request

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

post/receive

Request body

channelIdstring required

The identifier of the specific channel to execute payment through

sequenceIdstring required

Represents a unique id for the transaction from your end

amountinteger

Amount in USD to transact

localAmountinteger

The amount in local currency to transact

forceAcceptboolean

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

customerType'retail' | 'institution' required

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

redirectUrlstring

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.

customerUIDstring required

Unique identifier for the customer

countrystring

Country ISO 3166 code e.g. NG, KE, CI. This field is only required when using channelType

currencystring

Currency code e.g. NGN, KES, XAF, XOF. This field is only required when using channelType

channelType'bank' | 'momo'

directSettlementboolean

Response

200

channelIdstring

sequenceIdstring

amountinteger

currencystring

countrystring

partnerIdstring

apiKeystring

idstring

statusstring

convertedAmountinteger

ratenumber

expiresAtstring

createdAtstring

updatedAtstring

Example response

{
  "recipient": {
    "name": "John Doe",
    "country": "Nigeria",
    "phone": "+12514218828",
    "address": "Home Address",
    "dob": "02/01/1997",
    "email": "john.doe@yellowcard.io",
    "idNumber": "314159",
    "idType": "license"
  },
  "source": {
    "accountNumber": "0000000000",
    "accountType": "momo",
    "networkId": "995eb625-e23b-4d0b-bd90-18ce44cc17a3"
  },
  "channelId": "79da4d6e-1c42-4aac-ae7d-422730528f96",
  "sequenceId": "93f7c7f9-f2bb-450c-8f6d-1bd70766d36d",
  "amount": 1000,
  "currency": "XAF",
  "country": "CM",
  "partnerId": "9ecf5248-17e7-4a2b-b5a8-3bd58ff0fe01",
  "apiKey": "533fc4c3eaeb2a8f297a740ea178d830",
  "id": "7a1f2622-29b0-4e23-bb7e-bfc9883b78fa",
  "status": "created",
  "convertedAmount": 569480,
  "rate": 569.48,
  "expiresAt": "2023-02-02T13:50:06.298Z",
  "createdAt": "2023-02-02T13:50:06.298Z",
  "updatedAt": "2023-02-02T13:50:06.298Z"
}