List Transfers

3min
List Transfer API give you the ability to list all transfers (settlements) that has been done for your account.
This API is only available for Moyasar aggregation merchants.
﻿
Authentication
This API requries your secret API key in order to be used, learn more here Authentication﻿.
﻿
Pagination
This API supports pagination. It only returns 40 items at a time.
To list the second page of payouts, please use the page query parameters to specify the page number.
﻿
API
GET
Request
Query Parameters
page
optional
Integer
Specifies the page number to list. Default: 1
created[lt]
optional
String
Filter transfers created on or before the given date
created[gt]
optional
String
Filter transfers created on or after the given date
Header Parameters
Authentication
required
String
API key to authenticate the request.
Curl
PHP
Ruby
Python
C#
Java
Node.js
JS
curl https://apimig.moyasar.com/v1/transfers \
--header 'Authorization: Basic c2tfdGVzdF8xMjM6'
curl https://apimig.moyasar.com/v1/transfers \
--header 'Authorization: Basic c2tfdGVzdF8xMjM6'
Responses
200
401
{
    "transfers": [
        {
            "id": "22745f84-c648-5d39-b81a-66066c293d54",
            "recipient_type": "Entity",
            "recipient_id": "3a83ae78-bcd9-51fe-bd23-69cdbc8b212f",
            "currency": "SAR",
            "amount": 120000,
            "fee": 0,
            "tax": 0,
            "reference": "bank_ref_789",
            "transaction_count": 0,
            "created_at": "2023-02-11T08:06:54.000Z"
        },
        {
            "id": "3a6dcbc4-f93e-5b22-86ff-a40b11a207ea",
            "recipient_type": "Entity",
            "recipient_id": "3a83ae78-bcd9-51fe-bd23-69cdbc8b212f",
            "currency": "SAR",
            "amount": 100000,
            "fee": 0,
            "tax": 0,
            "reference": "bank_ref_123",
            "transaction_count": 4,
            "created_at": "2023-02-11T07:56:54.000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "next_page": null,
        "prev_page": null,
        "total_pages": 1,
        "total_count": 2
    }
}
{
    "transfers": [
        {
            "id": "22745f84-c648-5d39-b81a-66066c293d54",
            "recipient_type": "Entity",
            "recipient_id": "3a83ae78-bcd9-51fe-bd23-69cdbc8b212f",
            "currency": "SAR",
            "amount": 120000,
            "fee": 0,
            "tax": 0,
            "reference": "bank_ref_789",
            "transaction_count": 0,
            "created_at": "2023-02-11T08:06:54.000Z"
        },
        {
            "id": "3a6dcbc4-f93e-5b22-86ff-a40b11a207ea",
            "recipient_type": "Entity",
            "recipient_id": "3a83ae78-bcd9-51fe-bd23-69cdbc8b212f",
            "currency": "SAR",
            "amount": 100000,
            "fee": 0,
            "tax": 0,
            "reference": "bank_ref_123",
            "transaction_count": 4,
            "created_at": "2023-02-11T07:56:54.000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "next_page": null,
        "prev_page": null,
        "total_pages": 1,
        "total_count": 2
    }
}
﻿
﻿
Updated 18 Feb 2024
Did this page help you?
Webhook Reference
Show Transfer