Details to fulfill the payment¶

This document lists the required details that needs to be sent for each of our payout corridor.

You can get the list of all available corridors for target country using the

GET /corridors/[DESTINATION_COUNTRY]

endpoint, where the DESTINATION_COUNTRY is the ISO 3166-1 alpha-3 country code.

Occasionally there might be issues with one of the corridors and we might have to disable them temporarily. Once youre onboarded we'll let you know if this happens. Also if you're trying to use a disabled corridor you're going to receive a validation error stating that the corridor is not active, and you won't be able to create new transactions there.

United Kingdom¶

GBP¶

{
    "type": "bank",
    "input_currency_code": "USD",
    "output_currency_code": "GBP", // currency set to GBP
    "output_amount_in_cents": "400",
    "sender": {
        // sender details
    },
    "recipient": {
        // recipient details
        "country_code": "GBR", // country set to GBR
        "city": "London",
        "street": "Buckingham Palace Rd",
        "postal_code": "SW1W 0QH",
        "sort_code": "098765",
        "bank_account": "123456789",
        "bank_account_type": "current"
            // current
            // savings
    },
    "external_id": // external_id
}

Europe¶

EUR¶

{
    "type": "bank",
    "input_currency_code": "EUR",
    "output_currency_code": "EUR", // currency set to EUR
    "output_amount_in_cents": "500",
    "sender": {
        // sender details
    },
    "recipient": {
        // recipient details
        "country_code": "DEU",
        "city": "Berlin",
        "street": "Example Strasse 1",
        "postal_code": "12345",
        "iban": "BE65320028850496"
    },
    "external_id": // external_id
}

Global¶

USD¶

{
    "type": "bank",
    "input_currency_code": "USD",
    "output_currency_code": "USD", // currency set to USD
    "output_amount_in_cents": "500",
    "sender": {
        // sender details
    },
    "recipient": {
        // recipient details
        "country_code": "USA",
        "city": "Ney York",
        "street": "Example St",
        "postal_code": "12345",
        "bic": "USBKUS44XXX",
        "bank_account": "12345678",
        "bank_account_type": "current"
            // current
            // savings
    },
    "external_id": // external_id
}

Nigeria¶

NGN bank payment¶

{
    "type": "bank",
    "input_currency_code": "USD",
    "output_currency_code": "NGN", // currency set to NGN or USD
    "output_amount_in_cents": "400",
    "sender": {
        // sender details
    },
    "recipient": {
        // recipient details
        "country_code": "NGA", // country set to NGA
        "bank_name": "Example bank",
        "bank_code": "058",
        "bank_account": "123456789",
        "bank_account_type": "current"
            // current
            // savings
    },
    "external_id": // external_id
}

NGN cash payment¶

{
    "type": "cash",
    "input_currency_code": "USD",
    "output_currency_code": "NGN", // currency set to NGN or USD
    "output_amount_in_cents": "400",
    "sender": {
        // sender details
    },
    "recipient": {
        // recipient details
        "country_code": "NGA", // country set to NGA
        "phone_number": "+2348050888806", // NGA phone number
    },
    "external_id": // external_id
}

Make sure you will provide a valid phone_number for recipient which will match the country_code. We will send SMS message with reference and code to recipient for each cash pickup transaciton.

Depending on the bank, they may or may not require both reference and code to pickup the funds.