Conciliation
This route is used when you want to return data relating to Bank Conciliation on a specific date. The response will contain data related to the bank account as well as a summary of transactions (paid and refunded). If the date_created parameter is not passed in the request, the response will be from the last reconciliation operation recorded in our system.
It is possible to return a payload with only the bank details of the filtered day or also the transactions using the with_transactions parameter.
GETv1/conciliation
Request Query Params
| Attribute | Type | Description |
|---|---|---|
| date_created | dateTime | Conciliation creation date in ISODateTime format. |
| with_transactions | boolean | Extra parameter that can be passed if it is necessary to return the day's conciliation transactions. Default value: false. |
| pagination_type | boolean | If the parameter with_transactions is added as true, it is possible to add the pagination_type parameter to return the pagination of transactions. It is possible to return transactions of type paid or refunded.Default value: paid. |
| count | boolean | Returns n transaction objects. Maximum: 1,000 Default: 100. |
| page | boolean | Useful for implementing results pagination. |
caution
It is important to note that the date_created parameter uses ISODatetime (timestamp with milliseconds) to represent it.
Sample: in Javascript new Date().toISOString(), which will return something in the form 2021-09-23T00:00:00.000Z.
Response Object
| Property | Type | Description |
|---|---|---|
| transfer_reference_date | dateTime | Conciliation creation date in ISODate format. |
| transfer estimated amount | int32 | Amount in cents of the total to be transferred to the account. Result of subtraction between paid_transactions_amount and refunded_transactions_amount. |
| paid_transactions_amount | int32 | Amount in cents of the sum of all paid transactions. |
| refunded_transactions_amount | int32 | Amount in cents of the sum of all refunded transactions. |
| transfers | array | Array containing all transfers made to the conciliation bank account on the specific date. |
| paid_transactions | array | Object array containing the paid transactions relating to the conciliation of the specific date. |
| refunded_transactions | array | Array of object containing the refunded transactions relating to the reconciliation of the specific date. |
| pagination_type | boolean | Returns the type of transactions referring to the current pagination. |
| total | int32 | Total transactions that meet the filter passed in the query referring to the type passed in pagination_type. |
| page | int32 | Current page referring to offset of pages. |
| offset | int32 | Total pages for count divided by total of handled transactions in the queries. |
Transfers Array
| Property | Type | Description |
|---|---|---|
| transfer_amount | int32 | Transfer amount in cents. |
| transfer_type | string | Type of transfer performed. Possible values: ted and doc. |
| transfer_status | string | Status of the transfer performed. Possible values: pending_transfer, transferred, failed, processing and canceled. |
| transfer_bank_response | string | Response from the bank regarding the transfer made. Possible values: confirmed or null. |
| transfer_date_created | dateTime | Transfer creation date performed in ISODateTime format. |
| transfer_date_updated | dateTime | Transfer update date performed in ISODateTime format. |
| transfer_funding_date | dateTime | Effective date of the transfer carried out in ISODateTime format. |
| transfer_funding_estimated_date | dateTime | Estimated date of completion of the transfer carried out in ISODateTime format. |
| transfer_id | string | Identifier of the transfer performed. |
Samples
- With Transactions
- Without Transactions
curl -X GET -G "https://api.wu.global.marlim.co/v1/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created="2024-02-02T00:00:00.000Z" \
-d with_transactions=true
{
"paid_transactions_amount": 600000,
"refunded_transactions_amount": 100000,
"transfer_estimated_amount": 500000,
"transfer_reference_date": "2024-02-02",
"pagination_type": "paid",
"total": "3",
"page": "1",
"offset": "1",
"transfers": [
{
"transfer_amount": 500000,
"transfer_type": "ted",
"transfer_status": "transferred",
"transfer_bank_response": "confirmed",
"transfer_date_created": "2024-02-02T08:00:00.000Z",
"transfer_date_updated": "2024-02-02T09:00:00.000Z",
"transfer_funding_date": "2024-02-02T15:00:00.000Z",
"transfer_funding_estimated_date": "2024-02-03T00:00:00.000Z",
"transfer_id": "23456789"
}
],
"paid_transactions": [
{
"acquirer_status_code": "0000",
"status": "paid",
"authorization_code": "124356",
"nsu": "987654321",
"order_id": "2345678910",
"date_created": "2024-02-01T14:29:07.334Z",
"date_updated": "2024-02-01T14:31:07.334Z",
"net_value": 100000,
"authorized_amount": 110000,
"paid_amount": 110000,
"refunded_amount": 0,
"installments": "1",
"transaction_id": "12345678912346",
"card_holder_name": "Luke Skywalker",
"card_brand": "visa",
"card_first_digits": "4444555",
"card_last_digits": "2222",
"wu_payment_type": "MT",
"payment_method": "credit"
},
{
"acquirer_status_code": "0000",
"status": "paid",
"authorization_code": "124356",
"nsu": "987654321",
"order_id": "2345678910",
"date_created": "2024-02-01T14:29:07.334Z",
"date_updated": "2024-02-01T14:31:07.334Z",
"net_value": 200000,
"authorized_amount": 220000,
"paid_amount": 220000,
"refunded_amount": 0,
"installments": "1",
"transaction_id": "12345678912346",
"card_holder_name": "Luke Skywalker",
"card_brand": "visa",
"card_first_digits": "4444555",
"card_last_digits": "2222",
"wu_payment_type": "MT",
"payment_method": "debit"
},
{
"acquirer_status_code": "0000",
"status": "paid",
"authorization_code": "124356",
"nsu": "987654321",
"order_id": "2345678910",
"date_created": "2024-02-01T14:29:07.334Z",
"date_updated": "2024-02-01T14:31:07.334Z",
"net_value": 300000,
"authorized_amount": 330000,
"paid_amount": 330000,
"refunded_amount": 0,
"installments": "1",
"transaction_id": "12345678912346",
"card_holder_name": "Luke Skywalker",
"card_brand": "visa",
"card_first_digits": "4444555",
"card_last_digits": "2222",
"wu_payment_type": "MT",
"payment_method": "credit"
}
],
"refunded_transactions": [
{
"acquirer_status_code": "0000",
"status": "refunded",
"authorization_code": "243567",
"nsu": "987654323",
"order_id": "456789101112",
"date_created": "2024-02-01T14:29:07.334Z",
"date_updated": "2024-02-01T14:31:07.334Z",
"net_value": 100000,
"authorized_amount": 110000,
"paid_amount": 0,
"refunded_amount": 110000,
"installments": "1",
"transaction_id": "12345678912348",
"card_holder_name": "Lord Darth Vader",
"card_brand": "amex",
"card_first_digits": "777",
"card_last_digits": "9999",
"wu_payment_type": "MT",
"payment_method": "debit"
}
]
}
curl -X GET -G "https://api.wu.global.marlim.co/v1/conciliation" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created="2024-02-01T00:00:00.000Z"
{
"paid_transactions_amount": 3300000,
"refunded_transactions_amount": 0,
"transfer_estimated_amount": 3300000,
"transfer_reference_date": "2024-02-01",
"transfers": [
{
"transfer_amount": 3300000,
"transfer_type": "ted",
"transfer_status": "transferred",
"transfer_bank_response": "confirmed",
"transfer_date_created": "2024-02-01T08:00:00.000Z",
"transfer_date_updated": "2024-02-01T09:00:00.000Z",
"transfer_funding_date": "2024-02-01T15:00:00.000Z",
"transfer_funding_estimated_date": "2024-02-02T00:00:00.000Z",
"transfer_id": "12345678"
}
]
}