📖
Inyo Developer Portal
  • API REFERENCES
    • Payments Gateway v2
      • Getting started
      • Background
        • System architecture
        • Gateway environment settings
      • Authentication Methods
      • Environments
      • Technical Resources
      • Mitigating Fraud
      • APIs
        • Tokenizing cards
        • Payment
          • Pull Transaction
            • Handling AVS / CVC
            • Handling 3D secure
          • Push Transaction
          • Pull and push in one step
          • Capture
          • Refund
          • Void
          • Get a payment
          • Get a list
        • Webhooks
        • Domain tables
          • Response Code
          • Payment Status
        • Test data
          • Cards
    • Remittances
      • Getting Started
      • Authentication
      • Data Population
        • Country
        • State
        • Banks
        • Payers
        • Settlement Rates
      • Sender
        • Sender Object
        • Register a Sender
        • User Agreement
        • Get Sender by ID
        • Sender Verification
          • ID Documents
            • Expired ID Documents
          • KYC Status
          • KYC Using Widget
          • KYC Using API
            • Get KYC fields
            • Update KYC Information
            • Initiate KYC
            • Get KYC Information
          • Sender Tier Upgrade
        • Sender ID Information
      • Funding Account
        • Add Funding Account
          • OAuth Integration
        • Funding Account Object
        • Get Funding Account
        • Delete Funding Account
      • Recipient
        • Recipient Object
        • Add a Recipient
        • Get Recipient Details
        • Update Recipient
        • Recipient Document
      • Recipient Account
        • Recipient Account Object
        • Add a Recipient Account
        • Get Recipient Account
        • Get Account Information
      • Transaction
        • Transaction Object
        • Get Transaction Limits
        • Create a Transaction
          • 3DS Verification
          • Bonus/Discount
        • Get Transaction Details
        • Cancel Transaction
        • Delivery Request
        • Self-Payout
        • Transaction Invoice
      • Webhooks
        • Subscriptions
          • Subscribe
          • List Subscriptions
          • Pause Subscriptions
          • Remove Subscription
        • Integration
        • Events
      • Widget
        • Widget v1.0
          • Widget v1.0 Types
        • Widget v2.0
      • SANDBOX
        • Test Values
          • Geo-Fencing
          • Sender Verification
          • Funding Account
          • Transaction
  • USE CASE
    • Remittance
Powered by GitBook
On this page
  1. API REFERENCES
  2. Remittances
  3. Recipient Account

Recipient Account Object

Field
Type
Description

id

UUID

Unique ID of the recipient's account

recipient_id

UUID

ID of the recipient

account_number

string

Bank account number

account_type

string

Account type. Enumerated value: savings, checking, debit_card_deposit

bank_id

integer

branch_id

integer

branch_location

string

identification_value

string

Recipient's mobile wallet ID. Mobile Wallet ID is recipient phone number along with country code and area code.

identification_type

string

Recipient Wallet type. Enumerated value: TEL

payout_method

string

Payout Method type. Enumerated value: BANK_DEPOSIT, WALLET

payer_id

integer

account_holder_name.first_name

String

The account holder’s first name. When applicable, the provided account holder name is matched with the actual account holder’s name received from the bank/wallet provider for verification purposes. If this field is not provided, the first name of the recipient will be used.

account_holder_name.middle_name

String

The account holder’s middle name. If this field is not provided, the middle name of the recipient will be used.

account_holder_name.last_name

String

The account holder’s last name. If this field is not provided, the last name of the recipient will be used.

additional_info.routing_code

String

This field may be required for recipient accounts in the US. Please refer to your spec sheet.

additional_info.ifs_code

String

This field may be required for recipient accounts in India Please refer to your spec sheet.

additional_info.swift_bic_code

String

This field may be required for recipient accounts in the UK. Please refer to your spec sheet.

additional_info.branch_number

String

Branch number of bank.

additional_info.bsb_number

String

Bank-State-Branch is a six-digit number that identifies banks and branches.

additional_info.bik_code

String

Identification code of the bank.

additional_info.cbu_alias

String

Alphanumeric code for each bank account.

additional_info.sort_code

String

Six digit number that identifies recipient bank.

additional_info.aba_routing_number

String

Nine numeric characters used by banks to identify specific financial institutions.

PreviousRecipient AccountNextAdd a Recipient Account

Last updated 9 months ago

Bank ID. Details can be obtained from this .

Bank Branch ID. Details can be obtained from this .

Bank Branch Address. Details can be obtained from this .

ID of payer associated with receiver's wallet. Details can be obtained from this .

API
API
API
API