Recipient Accounts

Introduction

The Recipient-accounts API enables the application to create target account profile ID's for recipient's bank or wallet account. This profile is associated with a particular sender. Based on the partner's setup, the API will verify the recipient's account, so the application won't have to validate the account during a transaction.




API Sequence

The Recipient-Accounts API module is a single synchronous endpoint.


  1. Recipient Account Profiles | POST /recipient-account/v1/targetAccountProfiles

    To create a target account profile for a recipient's bank or wallet account the application must include, at minimum, the destination country, service option, and service option routing code, the sender's first and last name, the recipient's first and last name, address, city, country, mobile phone number, and the target account details for validation. The endpoint will successfully respond with a target account profile ID that can be used on subsequent transactions.


    API Sequence Diagram

Recipient Account Sequence Diagram


Endpoints


NameHTTP methodEndpointsDescription
Create Target Account ProfilePOST/recipient-account/v1/targetAccountProfilesCreates a Target Account Profile ID for a recipient's bank or wallet account.