SimpleAPI Available versions: 1.0 2.0

NAV

getTransfers

POST /v2/transfer/list

This endpoint allows the developer to retrieve the list of transfers previously created in the system for this particular company.

Parameters
Name
Description
transferListFilterModel (required)
Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found 
             {
    "date_from": "string",
    "date_to": "string",
    "filter_type": "SEND_ON",
    "search": "string",
    "first": 0,
    "count": 0,
    "locale": "string",
    "sort": "ID",
    "ascending": true
}
{ } TransferListFilterV2Model
date_from optional string
date_to optional string
filter_type optional string
search optional string
first optional integer
count optional integer
locale optional string
sort optional string
ascending optional boolean 
             [
    {
        "amount": 1.01,
        "available_for_cancel": true,
        "available_for_reject_or_approve": true,
        "created_on": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "currency_code": "AED",
        "customer_creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "customer_id": 0,
        "from_name": "string",
        "id": 0,
        "send_on": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "state": "DRAFT",
        "to_name": "string",
        "transfer_number": "string",
        "transfer_type": "INCOMING",
        "uuid": "string"
    }
]
{ } TransferPreviewV2Model
amount required number
available_for_cancel required boolean
available_for_reject_or_approve required boolean
created_on required string
currency_code required string
customer_creation_date required string
customer_id required integer
from_name required string
id required integer
send_on optional string
state required string
to_name required string
transfer_number required string
transfer_type required string
uuid required string 
             <transfer_list_filter_model>
  <date_from>string</date_from>
  <date_to>string</date_to>
  <filter_type>SEND_ON</filter_type>
  <search>string</search>
  <first>0</first>
  <count>0</count>
  <locale>string</locale>
  <sort>ID</sort>
  <ascending>1</ascending>
</transfer_list_filter_model>
{ } TransferListFilterV2Model
date_from optional string
date_to optional string
filter_type optional string
search optional string
first optional integer
count optional integer
locale optional string
sort optional string
ascending optional boolean 
             <transfer_preview_models>
  <transfer_preview_model>
    <amount>1.01</amount>
    <available_for_cancel>1</available_for_cancel>
    <available_for_reject_or_approve>1</available_for_reject_or_approve>
    <created_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</created_on>
    <currency_code>AED</currency_code>
    <customer_creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_creation_date>
    <customer_id>0</customer_id>
    <from_name>string</from_name>
    <id>0</id>
    <send_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</send_on>
    <state>DRAFT</state>
    <to_name>string</to_name>
    <transfer_number>string</transfer_number>
    <transfer_type>INCOMING</transfer_type>
    <uuid>string</uuid>
  </transfer_preview_model>
</transfer_preview_models>
{ } TransferPreviewV2Model
amount required number
available_for_cancel required boolean
available_for_reject_or_approve required boolean
created_on required string
currency_code required string
customer_creation_date required string
customer_id required integer
from_name required string
id required integer
send_on optional string
state required string
to_name required string
transfer_number required string
transfer_type required string
uuid required string