NAV

getTransfer

GET /v2/transfer/get

This endpoint allows the developer to locate existing transfers by transfer ID and to retrieve detailed information on the transfer status.

Parameters
Name
Description
transfer_id string (required)
Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "amount": 1.01,
    "attachments": [
        {
            "file": "string",
            "id": 0,
            "name": "string"
        }
    ],
    "currency": "AED",
    "description": "string",
    "fee_settings": [
        {
            "fee_id": 0,
            "fee_settings_template": {
                "company_fee_percent": 1.01,
                "company_fees_state": "ACTIVE",
                "cross_border_fee": 1.01,
                "customer_fee_percent": 1.01,
                "fee_collection_strategy": "IMMEDIATELY",
                "fee_settings_payment_method": "CREDIT_CARD",
                "fee_type": "AR_INVOICES",
                "id": 0,
                "profit_margin": 1.01,
                "transaction_fee": 1.01,
                "version": 0
            },
            "fee_version": 0,
            "id": 0,
            "selected_company_fee_percent": 1.01,
            "selected_customer_fee_percent": 1.01
        }
    ],
    "id": 0,
    "participants": [
        {
            "address": {
                "address": "string",
                "city": "string",
                "country": 0,
                "has_invoice": true,
                "id": 0,
                "province": 0,
                "selected": true,
                "zip": "string"
            },
            "email": "string",
            "full_name": "string",
            "id": 0,
            "payment_method": {
                "allow_preauthorize": true,
                "brand": "string",
                "ends": "string",
                "expire": "string",
                "pre_authorized": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
                "registered": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
                "state": "string"
            },
            "payment_method_id": 0,
            "side": "RECIPIENT",
            "type": "COMPANY",
            "version": 0
        }
    ],
    "progress": [
        {
            "date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
            "progress_step": "INITIATE_APPROVAL"
        }
    ],
    "send_on": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "transfer_number": "string",
    "transfer_state": "DRAFT",
    "transfer_type": "INCOMING",
    "user_id": 0,
    "uuid": "string",
    "version": 0
}
             
          
{ } TransferResponseV2Model
amount required number
attachments required array|FileV2Model
currency required string
description optional string
fee_settings required array|FeeResponseV2Model
id required integer
participants required array|TransferParticipantV2Model
progress required array|TransferProgressV2Model
send_on optional string
transfer_number required string
transfer_state required string
transfer_type required string
user_id required integer
uuid required string
version required integer
{ } FileV2Model
file optional string
id optional integer
name optional string
{ } FeeResponseV2Model
fee_id optional integer
fee_settings_template optional FeeSettingsV2Model
fee_version optional integer
id optional integer
selected_company_fee_percent optional number
selected_customer_fee_percent optional number
{ } TransferParticipantV2Model
address required AddressModel
email required string
full_name optional string
id required integer
payment_method optional PaymentMethodV2Model
payment_method_id optional integer
side required string
type required string
version optional integer
{ } TransferProgressV2Model
date optional string
progress_step required string
             <transfer_response_model>
  <amount>1.01</amount>
  <attachments>
    <attachment>
      <file>string</file>
      <id>0</id>
      <name>string</name>
    </attachment>
    <attachment>
      <file>string</file>
      <id>0</id>
      <name>string</name>
    </attachment>
  </attachments>
  <currency>AED</currency>
  <description>string</description>
  <fee_settings>
    <fee_setting>
      <fee_id>0</fee_id>
      <fee_settings_template/>
      <fee_version>0</fee_version>
      <id>0</id>
      <selected_company_fee_percent>1.01</selected_company_fee_percent>
      <selected_customer_fee_percent>1.01</selected_customer_fee_percent>
    </fee_setting>
    <fee_setting>
      <fee_id>0</fee_id>
      <fee_settings_template/>
      <fee_version>0</fee_version>
      <id>0</id>
      <selected_company_fee_percent>1.01</selected_company_fee_percent>
      <selected_customer_fee_percent>1.01</selected_customer_fee_percent>
    </fee_setting>
  </fee_settings>
  <id>0</id>
  <participants>
    <participant>
      <address/>
      <email>string</email>
      <full_name>string</full_name>
      <id>0</id>
      <payment_method/>
      <payment_method_id>0</payment_method_id>
      <side>RECIPIENT</side>
      <type>COMPANY</type>
      <version>0</version>
    </participant>
    <participant>
      <address/>
      <email>string</email>
      <full_name>string</full_name>
      <id>0</id>
      <payment_method/>
      <payment_method_id>0</payment_method_id>
      <side>RECIPIENT</side>
      <type>COMPANY</type>
      <version>0</version>
    </participant>
  </participants>
  <progress>
    <progress>
      <date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date>
      <progress_step>INITIATE_APPROVAL</progress_step>
    </progress>
    <progress>
      <date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date>
      <progress_step>INITIATE_APPROVAL</progress_step>
    </progress>
  </progress>
  <send_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</send_on>
  <transfer_number>string</transfer_number>
  <transfer_state>DRAFT</transfer_state>
  <transfer_type>INCOMING</transfer_type>
  <user_id>0</user_id>
  <uuid>string</uuid>
  <version>0</version>
</transfer_response_model>

             
          
{ } TransferResponseV2Model
amount required number
attachments required array|FileV2Model
currency required string
description optional string
fee_settings required array|FeeResponseV2Model
id required integer
participants required array|TransferParticipantV2Model
progress required array|TransferProgressV2Model
send_on optional string
transfer_number required string
transfer_state required string
transfer_type required string
user_id required integer
uuid required string
version required integer
{ } FileV2Model
file optional string
id optional integer
name optional string
{ } FeeResponseV2Model
fee_id optional integer
fee_settings_template optional FeeSettingsV2Model
fee_version optional integer
id optional integer
selected_company_fee_percent optional number
selected_customer_fee_percent optional number
{ } TransferParticipantV2Model
address required AddressModel
email required string
full_name optional string
id required integer
payment_method optional PaymentMethodV2Model
payment_method_id optional integer
side required string
type required string
version optional integer
{ } TransferProgressV2Model
date optional string
progress_step required string