Getting started

Last edit: Apr 11, 2022

TerraPay is a global mobile-first payments service that allows anyone, anywhere, to send and receive money to a wallet or bank account instantly.

TerraPay’s API offers a comprehensive solution for online and offline remittances for various businesses - from start-ups to global enterprises. It ensures a smooth experience and a quicker settlement process for its clients. TerraPay provides a full-service API that ensures one-time integration is sufficient to fulfil all the business needs in money transfers.

Business confirmation

To partner with TerraPay, please click here to share your details. Our team of experts will reach out to you to proceed further.

Non-Disclosure Agreement (NDA): Once the business requirements are finalized, an NDA will be signed between the partners and TerraPay.

Contract: A contract will be signed between both parties post finalization of requirements and due diligence.

Information required/shared with partners: The below information will be shared between the partners and the TerraPay team once the requirements are finalized.

For Send partners:

On-Boarding

On business confirmation, the partner will be onboarded to the TerraPay platform. A user ID will be created to access the developer portal. The partner will be provided with Login & API credentials. Authentication of the ID during login will be based on the domain name.

The user is validated by an OTP that is sent to the registered email address.

Developer portal

Dashboard

On successful login, the partner will be able to view a dashboard.

• Status of test scenarios conducted at various stages of integration at all developmental environments-Test, Sandbox, UAT, Production. The labels of the various environments can be customized as per the partner’s business needs.
• Status of tests for the various corridors at different stages of environment
• Details regarding the numbers of test scenarios, the status of the transactions and transaction information.

The information presented on the dashboard will aid the send partner in deciding on the readiness to go live for a particular corridor or through a particular money transfer instrument

Corridor

The partner can request a new corridor activation in the developer portal. TerraPay’s operations team will review the request for compliance and provide approval accordingly.

The status of the requested corridors and payment instruments can be viewed by the user.

Preferences or configurations for each of the active corridors can be viewed in the portal.

Test Environments

Sandbox and UAT: Detailed information regarding the test scenarios and data used with expected output is displayed for the partners in the developer portal.

API key

The API key can be reset for the sandbox and UAT environment in the developer portal.

APIs

The process of integration and testing is based on whether the partner is a send /Receive partner.

The APIs are available in three stages-Sandbox, UAT and LIVE. The API key is different for each stage, and it is a recommended best practice to rotate/regenerate the key periodically.

Categories

• Send Partner Integration: Partner will integrate with TerraPay through TerraPay’s GSMA API or TerraPay’s web-based ASAP interface.
• Receive Partner Integration: TerraPay to integrate with partner’s API.

Available APIs

The below APIs are available for send partners to integrate.

• View Account Status APIs for bank and mobile wallet
• Create a Quotation
• Create A Transaction
• View A Transaction
• Ledger Balance
• Corridor Quotation
• Cancel Transaction
• Reverse Transaction
• Statements API
• Get Bank List

View the detailed API documentation here.

SDK

TerraPay offers an SDK that the send partner can use to test their integration. A single downloadable library is available for the partners.

The SDK makes use of all the APIs provided by TerraPay to enable testing of the important features in money transfer.

Try-it

TerraPay offers a novel platform called “Try-it” to developers to test their input data during Sandbox or UAT testing. The developer can just enter the input parameters in the given input boxes and you can view the response! No repeated code change. The test data can be validated immediately. A validated user can verify their input test data in the UAT environment.