API Test Keys

Fetch Settlement Recon Details

GET

/v1/settlements/recon/combined?year=yyyy&month=mm

Click to copy

Use this endpoint to return a list of all transactions such as payments, refunds, transfers and adjustments settled to your account on a particular day or month. In the example request and response, we are fetching the settlement report for a particular day, that is 11/06/2022.

Is this page helpful?

Success

Failure

1{
2  "entity": "collection",
3  "count": 4,
4  "items": [
5    {
6      "entity_id": "pay_DEXrnipqTmWVGE",
7      "type": "payment",
8      "debit": 0,
9      "credit": 97100,
10      "amount": 100000,
11      "currency": "MYR",
12      "fee": 2900,
13      "tax": 0,
14      "on_hold": false,
15      "settled": true,
16      "created_at": 1567692556,
17      "settled_at": 1568176960,
18      "settlement_id": "setl_DGlQ1Rj8os78Ec",
19      "posted_at": null,
20      "credit_type": "default",
21      "description": "Recurring Payment via Subscription",
22      "notes": "Beam me up Scotty.",
23      "payment_id": null,
24      "settlement_utr": "1568176960vxp0rj",
25      "order_id": "order_DEXrnRiR3SNDHA",
26      "order_receipt": null,
27      "method": "card",
28      "card_network": "MC",
29      "card_issuer": "PHBM",
30      "card_type": "credit",
31      "dispute_id": null
32    },
33    {
34      "entity_id": "rfnd_DGRcGzZSLyEdg1",
35      "type": "refund",
36      "debit": 242500,
37      "credit": 0,
38      "amount": 242500,
39      "currency": "MYR",
40      "fee": 0,
41      "tax": 0,
42      "on_hold": false,
43      "settled": true,
44      "created_at": 1568107224,
45      "settled_at": 1568176960,
46      "settlement_id": "setl_DGlQ1Rj8os78Ec",
47      "posted_at": null,
48      "credit_type": "default",
49      "description": null,
50      "notes": "Beam me up Scotty.",
51      "payment_id": "pay_DEXq1pACSqFxtS",
52      "settlement_utr": "1568176960vxp0rj",
53      "order_id": "order_DEXpmZgffXNvuI",
54      "order_receipt": null,
55      "method": "card",
56      "card_network": "MC",
57      "card_issuer": "PHBM",
58      "card_type": "credit",
59      "dispute_id": null
60    },
61    {
62      "entity_id": "trf_DEUoCEtdsJgvl7",
63      "type": "transfer",
64      "debit": 100296,
65      "credit": 0,
66      "amount": 100000,
67      "currency": "MYR",
68      "fee": 296,
69      "tax": 46,
70      "on_hold": false,
71      "settled": true,
72      "created_at": 1567681786,
73      "settled_at": 1568176960,
74      "settlement_id": "setl_DGlQ1Rj8os78Ec",
75      "posted_at": null,
76      "credit_type": "default",
77      "description": null,
78      "notes": null,
79      "payment_id": "pay_DEApNNTR6xmqJy",
80      "settlement_utr": "1568176960vxp0rj",
81      "order_id": null,
82      "order_receipt": null,
83      "method": null,
84      "card_network": null,
85      "card_issuer": null,
86      "card_type": null,
87      "dispute_id": null
88    },
89    {
90      "entity_id": "adj_EhcHONhX4ChgNC",
91      "type": "adjustment",
92      "debit": 0,
93      "credit": 1012,
94      "amount": 1012,
95      "currency": "MYR",
96      "fee": 0,
97      "tax": 0,
98      "on_hold": false,
99      "settled": true,
100      "created_at": 1567681786,
101      "settled_at": 1568176960,
102      "settlement_id": "setl_DGlQ1Rj8os78Ec",
103      "posted_at": null,
104      "description": "test reason",
105      "notes": null,
106      "payment_id": null,
107      "settlement_utr": null,
108      "order_id": null,
109      "order_receipt": null,
110      "method": null,
111      "card_network": null,
112      "card_issuer": null,
113      "card_type": null,
114      "dispute_id": null
115    }
116  ]
117}

Query Parameters

year

integer

The year the settlement was received in the YYYY format. For example, 2022.

month

integer

The month the settlement was received in the MM format. For example, 06.

day

integer

The date on which the settlement was received in the DD format. For example, 11.

count

integer

Specifies the number of available settlements to be fetched. Possible values: 1 to 1000.

skip

integer

Specifies the number of available settlements to be skipped when fetching a count.

Response Parameters

entity_id

string

The unique identifier of the transaction that has been settled.

type

string

Indicates the type of transaction. Possible values:

payment
refund
transfer
adjustment

debit

integer

The amount, in currency subunits, that has been debited from your account.

credit

integer

The amount, in currency subunits, that has been credited to your account.

amount

integer

The total amount, in currency subunits, debited or credited from your account.

currency

string

The 3-letter ISO currency code for the transaction.

fee

integer

The fees, in currency subunits, charged to process the transaction.

tax

integer

The tax on the fee, in currency subunits, charged to process the transaction.

on_hold

boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

true
false

settled

boolean

Indicates whether the transaction has been settled or not. Possible values:

true
false

created_at

integer

Unix timestamp at which the transaction was created.

settled_at

integer

Unix timestamp when the transaction was settled.

settlement_id

string

The unique identifier of the settlement transaction.

description

string

Brief description about the transaction.

notes

object

Notes for the transaction. For example, Beam me up Scotty.

payment_id

string

The unique identifier of the payment linked to refund or transfer that has been settled. For example, pay_DEApNNTR6xmqJy. It is null for payments.

settlement_utr

string

The unique reference number linked to the settlement. For example, KKBKH14156891582.

order_id

string

Order id linked to the payment made by the customer that has been settled. For example, order_DEXrnRiR3SNDHA.

order_receipt

string

Receipt number entered while

creating the Order

method

string

The payment method used to complete the payment. Possible values:

card
fpx
wallet

card_network

string

The card network used to process the payment. Possible values:

MC
VISA
unknown

card_issuer

string

This is a 4-character code denoting the issuing bank. For example, PHBM.

This attribute will not be set for international cards, that is, for cards issued by foreign banks.

card_type

string

The card type used to process the payment. Possible values:

credit
debit

dispute_id

string

The unique identifier of any dispute, if any, for this transaction.

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

The year must be 4 digits.

Error Status: 400

An invalid year is entered.

Solution

The month is not a valid month.

Error Status: 400

An invalid month is entered.

Solution

The day must be between 1 and 2 digits.

Error Status: 400

An invalid day is entered.

Solution

The count must be at least 1.

Error Status: 400

The count passed is 0.

Solution

Fetch Settlement Recon Details

GET

/v1/settlements/recon/combined?year=yyyy&month=mm

Click to copy

Is this page helpful?

Query Parameters

year

integer

The year the settlement was received in the YYYY format. For example, 2022.

month

integer

The month the settlement was received in the MM format. For example, 06.

day

integer

The date on which the settlement was received in the DD format. For example, 11.

count

integer

Specifies the number of available settlements to be fetched. Possible values: 1 to 1000.

skip

integer

Specifies the number of available settlements to be skipped when fetching a count.

Response Parameters

entity_id

string

The unique identifier of the transaction that has been settled.

type

string

Indicates the type of transaction. Possible values:

payment
refund
transfer
adjustment

debit

integer

The amount, in currency subunits, that has been debited from your account.

credit

integer

The amount, in currency subunits, that has been credited to your account.

amount

integer

The total amount, in currency subunits, debited or credited from your account.

currency

string

The 3-letter ISO currency code for the transaction.

fee

integer

The fees, in currency subunits, charged to process the transaction.

tax

integer

The tax on the fee, in currency subunits, charged to process the transaction.

on_hold

boolean

Indicates whether the account settlement for transfer is on hold. Possible values:

true
false

settled

boolean

Indicates whether the transaction has been settled or not. Possible values:

true
false

created_at

integer

Unix timestamp at which the transaction was created.

settled_at

integer

Unix timestamp when the transaction was settled.

settlement_id

string

The unique identifier of the settlement transaction.

description

string

Brief description about the transaction.

notes

object

Notes for the transaction. For example, Beam me up Scotty.

payment_id

string

The unique identifier of the payment linked to refund or transfer that has been settled. For example, pay_DEApNNTR6xmqJy. It is null for payments.

settlement_utr

string

The unique reference number linked to the settlement. For example, KKBKH14156891582.

order_id

string

Order id linked to the payment made by the customer that has been settled. For example, order_DEXrnRiR3SNDHA.

order_receipt

string

Receipt number entered while

creating the Order

method

string

The payment method used to complete the payment. Possible values:

card
fpx
wallet

card_network

string

The card network used to process the payment. Possible values:

MC
VISA
unknown

card_issuer

string

This is a 4-character code denoting the issuing bank. For example, PHBM.

This attribute will not be set for international cards, that is, for cards issued by foreign banks.

card_type

string

The card type used to process the payment. Possible values:

credit
debit

dispute_id

string

The unique identifier of any dispute, if any, for this transaction.

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

The year must be 4 digits.

Error Status: 400

An invalid year is entered.

Solution

The month is not a valid month.

Error Status: 400

An invalid month is entered.

Solution

The day must be between 1 and 2 digits.

Error Status: 400

An invalid day is entered.

Solution

The count must be at least 1.

Error Status: 400

The count passed is 0.

Solution

Success

Failure

1{
2  "entity": "collection",
3  "count": 4,
4  "items": [
5    {
6      "entity_id": "pay_DEXrnipqTmWVGE",
7      "type": "payment",
8      "debit": 0,
9      "credit": 97100,
10      "amount": 100000,
11      "currency": "MYR",
12      "fee": 2900,
13      "tax": 0,
14      "on_hold": false,
15      "settled": true,
16      "created_at": 1567692556,
17      "settled_at": 1568176960,
18      "settlement_id": "setl_DGlQ1Rj8os78Ec",
19      "posted_at": null,
20      "credit_type": "default",
21      "description": "Recurring Payment via Subscription",
22      "notes": "Beam me up Scotty.",
23      "payment_id": null,
24      "settlement_utr": "1568176960vxp0rj",
25      "order_id": "order_DEXrnRiR3SNDHA",
26      "order_receipt": null,
27      "method": "card",
28      "card_network": "MC",
29      "card_issuer": "PHBM",
30      "card_type": "credit",
31      "dispute_id": null
32    },
33    {
34      "entity_id": "rfnd_DGRcGzZSLyEdg1",
35      "type": "refund",
36      "debit": 242500,
37      "credit": 0,
38      "amount": 242500,
39      "currency": "MYR",
40      "fee": 0,
41      "tax": 0,
42      "on_hold": false,
43      "settled": true,
44      "created_at": 1568107224,
45      "settled_at": 1568176960,
46      "settlement_id": "setl_DGlQ1Rj8os78Ec",
47      "posted_at": null,
48      "credit_type": "default",
49      "description": null,
50      "notes": "Beam me up Scotty.",
51      "payment_id": "pay_DEXq1pACSqFxtS",
52      "settlement_utr": "1568176960vxp0rj",
53      "order_id": "order_DEXpmZgffXNvuI",
54      "order_receipt": null,
55      "method": "card",
56      "card_network": "MC",
57      "card_issuer": "PHBM",
58      "card_type": "credit",
59      "dispute_id": null
60    },
61    {
62      "entity_id": "trf_DEUoCEtdsJgvl7",
63      "type": "transfer",
64      "debit": 100296,
65      "credit": 0,
66      "amount": 100000,
67      "currency": "MYR",
68      "fee": 296,
69      "tax": 46,
70      "on_hold": false,
71      "settled": true,
72      "created_at": 1567681786,
73      "settled_at": 1568176960,
74      "settlement_id": "setl_DGlQ1Rj8os78Ec",
75      "posted_at": null,
76      "credit_type": "default",
77      "description": null,
78      "notes": null,
79      "payment_id": "pay_DEApNNTR6xmqJy",
80      "settlement_utr": "1568176960vxp0rj",
81      "order_id": null,
82      "order_receipt": null,
83      "method": null,
84      "card_network": null,
85      "card_issuer": null,
86      "card_type": null,
87      "dispute_id": null
88    },
89    {
90      "entity_id": "adj_EhcHONhX4ChgNC",
91      "type": "adjustment",
92      "debit": 0,
93      "credit": 1012,
94      "amount": 1012,
95      "currency": "MYR",
96      "fee": 0,
97      "tax": 0,
98      "on_hold": false,
99      "settled": true,
100      "created_at": 1567681786,
101      "settled_at": 1568176960,
102      "settlement_id": "setl_DGlQ1Rj8os78Ec",
103      "posted_at": null,
104      "description": "test reason",
105      "notes": null,
106      "payment_id": null,
107      "settlement_utr": null,
108      "order_id": null,
109      "order_receipt": null,
110      "method": null,
111      "card_network": null,
112      "card_issuer": null,
113      "card_type": null,
114      "dispute_id": null
115    }
116  ]
117}