Remittances enriched with the MoMo CashTransfer API

MoMo Dev Community   the Remittance API has been enriched and designed to facilitate the efficient capture of Know Your Customer (KYC) details for both the payer and payee involved in fund transfers. From the business and customer feedback with regulatory consultations, we have introduced the new MoMo CashTransfer API, set to replace the current remittance transfer API.

The API offers comprehensive capabilities for B2B, C2B, and B2C, C2C transactions. Whether you're looking to invest in an overseas business, receive your salary on your local MoMo wallet from a foreign employer, or send financial support to your parents abroad, the API has you covered for these tasks and more.

We highly recommend that businesses currently utilizing the remittance transfer API start planning to transition to the new MoMo Remittance CashTransfer API.

The API includes several detailed fields to better support compliance and business needs.

Below are the descriptions for the newly added fields:

Field Descriptions:

• amount: This is the sum that the recipient will receive following currency conversion.
• currency: Specifies the type of currency in which the recipient will receive the amount. (ISO 4217 Currency Codes)
• payee: Contains information about the beneficiary.
  • partyId: A unique identifier for the recipient, which could be a phone number, email, or a designated party code.
  • partyIdType: The kind of identifier being used, such as MSISDN, EMAIL, or PARTY_CODE.
• externalId: This is the transaction ID used for business applications and is useful for reconciliation purposes.
• originatingCountry: The country from which the funds are being sent.
• originalAmount: The initial sum to be received before any currency conversion takes place.
• originalCurrency: The currency in which the original sum is denominated. (ISO 4217 Currency Codes)
• payerMessage: A message that will be delivered to the sender.
• payeeNote: A note that will be delivered to the beneficiary.
• payerIdentificationType: The type of identification used for the sender, with possible values including CPFA, SRSA, NRIN, etc. 

  Payer Identification Types

  CPFA - CPF account number 
  SRSA - SRS account number
  NRIN - National registration identification number
  OTHR - Other
  DRLC - Drivers license number 
  PASS - Passport number 
  SOCS - Social security number 
  AREG - Alien registration number 
  IDCD - Identity card number
  EMID - Employer identification number

• payerIdentificationNumber: The identification number that corresponds to the specified identification type.
• payerIdentity: The MSISDN utilized by the sender in the country where the remittance originates. Format: (ID:6873248686/MSISDN)
• payerFirstName / payerSurName: The given name and surname of the sender.
• payerLanguageCode: The linguistic code corresponding to the sender's nation. ISO_639-1
• payerEmail: The sender's electronic mail address.
• payerMsisdn: The phone number of the sender.
• payerGender: The sex of the sender. (MALE, FEMALE, OTHER)

Run in Postman 

### Notes:
Make sure to replace the example values with actual data when making API requests. Each field is marked as required, indicating that they must be included for the request to be valid.

### Error Insights

ORIGINAL_PAYER_IDENTIFICATION_NOT_REGISTERED - This indicates that the identity number provided for the payer does not match the one used during their initial transaction.

HTTP 400 Bad Request

Please verify the following details:

- payerIdentificationType must be one of the following: 'CPFA', 'SRSA', 'NRIN', 'OTHR', 'DRLC', 'PASS', 'SOCS', 'AREG', or 'IDCD'.

- payerLanguageCode should comply with  ISO_639-1 standards.

- originalCurrency must adhere to (ISO 4217 Currency Codes).

- payerEmail should be a valid email address.

HTTP 500 Server Error

Ensure that payerGender values are correctly set to either MALE, FEMALE, or OTHER.

Transitioning from Remittance Transfer to Remittance Cash Transfer

What remains unchanged are the API User and Key, as well as the remittance subscription key. You can find these in your profile   User: Profile - MoMo Developer Portal – SandBox (mtn.com) or User: Profile - MoMo Developer Portal – Production (mtn.com)

What’s altered is the Endpoint URL, which has been updated  from https://proxy.momoapi.mtn.com/remittance/v1_0/transfer  to https://proxy.momoapi.mtn.com/remittance/v2_0/cashtransfer 

Additionally, the content of the Body has been enhanced with new fields as previously mentioned.

MoMo Developer Portal - Go live

We trust this update will significantly enhance the efficiency and compliance of your fund transfer operations. Thank you for your continued support and cooperation.

MoMo API Team