v1

latestOpenAPI 3.1.02026-07-26460218.4 KB

Submit Send Request

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

post/send

Request body

channelIdstring

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

reasonstring required

The reason for the withdrawal. See guide for supported payment reasons

forceAccepttrue | false required

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

customerType'retail' | 'institution' required

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.

customerUIDstring required

Unique identifier for the customer

channelType'momo' | 'bank'

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

directSettlementboolean

Response

200

idstring

channelIdstring

sequenceIdstring

currencystring

countrystring

amountinteger

reasonstring

convertedAmountinteger

statusstring

rateinteger

createdAtstring

updatedAtstring

expiresAtstring

Example response

{
  "id": "12",
  "channelId": "12",
  "sequenceId": "123",
  "currency": "GHS",
  "country": "GH",
  "amount": 500,
  "reason": "entertainment",
  "convertedAmount": 20000,
  "status": "created",
  "rate": 14,
  "sender": {
    "name": "Justin",
    "country": "United States",
    "phone": "+12514218828",
    "address": "1404 Attwater Dr.",
    "dob": "02/01/1997",
    "email": "justin@yellowcard.io",
    "idNumber": "12345",
    "idType": "license"
  },
  "destination": {
    "accountName": "Elom",
    "accountNumber": "123",
    "accountType": "bank",
    "networkId": "012"
  },
  "createdAt": "2022-12-18T23:54:55.380Z",
  "updatedAt": "2022-12-18T23:54:55.380Z",
  "expiresAt": "2023-02-02T09:40:48.628Z"
}