Inyo

Africa

A complete POST /v2/payment body for each validated African payout corridor. Expand a country to see it.

Bodies marked tested are payloads the gateway accepted in corridor testing, with only the environment metadata replaced — externalPaymentId, fxId, ipAddress, and the sender's name. The account numbers, bank codes, wallet identifiers, purpose codes, and amounts are the ones that were actually submitted. Bodies marked generated are built from the country's schema for corridors testing did not reach; they are structurally correct but their identifiers are placeholders that address nobody.

Every body on this page validates against its country schema and against the generic push schema. Swap in your own externalPaymentId, a live fxId from Foreign Exchange, and real recipient details before sending. See Country coverage for what each corridor requires.

Côte d'Ivoire — CIV · XOF · WALLET · schema v1.0.1

WALLET · MTN — tested

{
  "externalPaymentId": "push-civ-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 11384,
    "currency": "XOF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Yao Francis Timothé",
    "lastName": "Yao",
    "address": {
      "countryCode": "CIV",
      "city": "Abidjan",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "CIV",
      "walletId": "+2250153898945",
      "walletType": "PHONENUMBER",
      "walletOperator": "MTN"
    }
  },
  "additionalData": {}
}

WALLET · ORANGE_MONEY — tested

{
  "externalPaymentId": "push-civ-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 11384,
    "currency": "XOF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Yao Francis Timothé",
    "lastName": "Yao",
    "address": {
      "countryCode": "CIV",
      "city": "Abidjan",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "CIV",
      "walletId": "+2250153898945",
      "walletType": "PHONENUMBER",
      "walletOperator": "ORANGE_MONEY"
    }
  },
  "additionalData": {}
}

WALLET · MOOV — tested

{
  "externalPaymentId": "push-civ-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 11384,
    "currency": "XOF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Yao Francis Timothé",
    "lastName": "Yao",
    "address": {
      "countryCode": "CIV",
      "city": "Abidjan",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "CIV",
      "walletId": "+2250153898945",
      "walletType": "PHONENUMBER",
      "walletOperator": "MOOV"
    }
  },
  "additionalData": {}
}

Egypt — EGY · EGP · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-egy-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 1004,
    "currency": "EGP"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "EGY",
      "city": "Test City"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "EGY",
      "bankCode": "NBEGEGCX",
      "accountNumber": "EG380019000500000000263180002",
      "accountType": "CHECKING"
    }
  },
  "additionalData": {
    "paymentPurpose": "ISCOLL"
  }
}

Guinea — GIN · GNF · WALLET · schema v1.0.1

WALLET · MTN_MOBILE_MONEY — tested

{
  "externalPaymentId": "push-gin-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 175264,
    "currency": "GNF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Diallo",
    "lastName": "Mariama cire",
    "address": {
      "countryCode": "GIN",
      "city": "Conakry",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "GIN",
      "walletId": "+224620883048",
      "walletType": "PHONENUMBER",
      "walletOperator": "MTN_MOBILE_MONEY"
    }
  },
  "additionalData": {}
}

WALLET · ORANGE_MONEY — tested

{
  "externalPaymentId": "push-gin-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 175264,
    "currency": "GNF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Diallo",
    "lastName": "Mariama cire",
    "address": {
      "countryCode": "GIN",
      "city": "Conakry",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "GIN",
      "walletId": "+224620883048",
      "walletType": "PHONENUMBER",
      "walletOperator": "ORANGE_MONEY"
    }
  },
  "additionalData": {}
}

Kenya — KEN · KES · BANK_DEPOSIT · WALLET · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-ken-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 2574,
    "currency": "KES"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "KEN",
      "city": "Test City",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "KEN",
      "bankCode": "01100",
      "accountNumber": "12345678901234",
      "accountType": "CHECKING"
    },
    "documents": [
      {
        "document": "12345678",
        "type": "ID",
        "countryCode": "KEN"
      }
    ]
  },
  "additionalData": {
    "statementNarrative": "Family support"
  }
}

WALLET · AIRTEL_MONEY — tested

{
  "externalPaymentId": "push-ken-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 2585,
    "currency": "KES"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "KEN",
      "walletId": "+254712345678",
      "walletType": "PHONENUMBER",
      "walletOperator": "AIRTEL_MONEY"
    }
  },
  "additionalData": {}
}

WALLET · EQUITEL_MONEY — tested

{
  "externalPaymentId": "push-ken-001",
  "paymentType": "PUSH",
  "ipAddress": "203.0.113.42",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 2585,
    "currency": "KES"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "KEN",
      "walletId": "+254712345678",
      "walletType": "PHONENUMBER",
      "walletOperator": "EQUITEL_MONEY"
    }
  }
}

Madagascar — MDG · MGA · WALLET · schema v1.0.1

WALLET · MVOLA — tested

{
  "externalPaymentId": "push-mdg-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 85666.63,
    "currency": "MGA"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "MDG",
      "walletId": "+261340000000",
      "walletType": "PHONENUMBER",
      "walletOperator": "MVOLA"
    }
  },
  "additionalData": {}
}

WALLET · ORANGE_MONEY — tested

{
  "externalPaymentId": "push-mdg-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 85666.63,
    "currency": "MGA"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "MDG",
      "walletId": "+261340000000",
      "walletType": "PHONENUMBER",
      "walletOperator": "ORANGE_MONEY"
    }
  },
  "additionalData": {}
}

WALLET · AIRTEL_MONEY — tested

{
  "externalPaymentId": "push-mdg-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 85666.63,
    "currency": "MGA"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "MDG",
      "walletId": "+261340000000",
      "walletType": "PHONENUMBER",
      "walletOperator": "AIRTEL_MONEY"
    }
  },
  "additionalData": {}
}

Mali — MLI · XOF · WALLET · schema v1.0.1

WALLET · ORANGE_MONEY_MALI — tested

{
  "externalPaymentId": "push-mli-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 11384,
    "currency": "XOF"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Issa Anon",
    "lastName": "Guindo",
    "address": {
      "countryCode": "MLI",
      "city": "Bamako",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "MLI",
      "walletId": "+22376449248",
      "walletType": "PHONENUMBER",
      "walletOperator": "ORANGE_MONEY_MALI"
    }
  },
  "additionalData": {}
}

Morocco — MAR · MAD · BANK_DEPOSIT · schema v1.0.1

BANK_DEPOSIT — tested

{
  "externalPaymentId": "push-mar-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 184,
    "currency": "MAD"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "line2": "",
      "zipCode": "AAAAA"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "MAR",
      "city": "Test City"
    },
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "MAR",
      "bankCode": "BCMAMAMC",
      "accountNumber": "011810000001234567890193",
      "accountType": "CHECKING"
    }
  },
  "additionalData": {}
}

Nigeria — NGA · NGN · WALLET · schema v1.0.1

WALLET · SMARTCASH — tested

{
  "externalPaymentId": "push-nga-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 20.0,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 3158,
    "currency": "NGN"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "address": {
      "countryCode": "NGA",
      "city": "Lagos",
      "line1": "123 Main Street"
    },
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "NGA",
      "walletId": "+2341234567890",
      "walletType": "PHONENUMBER",
      "walletOperator": "SMARTCASH"
    }
  },
  "additionalData": {}
}

The Gambia — GMB · GMD · BANK_DEPOSIT · WALLET · schema v1.0.1

WALLET — generated

{
  "externalPaymentId": "push-gmb-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 100,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 6700,
    "currency": "GMD"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "zipCode": "10001"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "WALLET",
      "countryCode": "GMB",
      "walletId": "+2207123456",
      "walletType": "RANDOM",
      "walletOperator": "SAMPLE"
    }
  },
  "additionalData": {
    "paymentPurpose": "PT1"
  }
}

BANK_DEPOSIT — generated

{
  "externalPaymentId": "push-gmb-001",
  "fxId": "b40597a6-0312-4ac0-982d-7158a30f52a3",
  "ipAddress": "203.0.113.42",
  "paymentType": "PUSH",
  "amount": {
    "total": 100,
    "currency": "USD"
  },
  "recipientAmount": {
    "total": 6700,
    "currency": "GMD"
  },
  "sender": {
    "firstName": "John",
    "lastName": "Smith",
    "address": {
      "countryCode": "USA",
      "stateCode": "NY",
      "city": "New York",
      "line1": "123 Main St",
      "zipCode": "10001"
    }
  },
  "recipient": {
    "firstName": "Jane",
    "lastName": "Doe",
    "paymentMethod": {
      "type": "BANK_DEPOSIT",
      "countryCode": "GMB",
      "accountNumber": "1234567890"
    }
  },
  "additionalData": {
    "paymentPurpose": "PT1"
  }
}

What's Next

  • Country coverage — Every corridor's requirements in one table
  • Payout methods — Field reference per payout type
  • Errors — What PAY_001 means when a valid payload is rejected
PreviousExamplesNextAmericas