POST /settlements
GET /settlements
GET /settlements/{id}
GET /settlements/id/funding_transfer
DEL /settlements/{id}/transfers
POST /settlements/{id}/transfers
Close the currently accruing settlement
.
Finix, by default, creates accruing settlements
then closes them based on your payout configurations. Use this endpoint to manually close the currently accruing settlement.
The closed Settlement
will not accrue any further transactions and gets immediately submitted for approval.
Transfers
get included in Settlements
as a deduction.Transfers
don't get included in Settlements
. total_amount
minus the total_fee
equals the net_amount
. The net_amount
is the amount in cents that gets deposited into the seller's bank account.Related Guides: Accruing Settlements
Settlement
object.
Error
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Merchant identity disabled error
curl https://finix.sandbox-payments-api.com/identities/IDrH4G2VTfNjn1VFkvhcyMYj/settlements \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X POST \ -d ' { "currency": "USD", "processor": "DUMMY_V1", "tags": { "Internal Daily Settlement ID": "21DFASJSAKAS" } }'
{- "id": "STimypRqs5TXoCDRq2swMFUY",
- "created_at": "2022-08-09T17:06:02.99Z",
- "updated_at": "2022-08-09T17:15:25.60Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDuqZpDw28f2KK6YuDk4jNLg",
- "merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
- "net_amount": 2238357,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 2287662,
- "total_fee": 49305,
- "total_fees": 49305,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}
Retrieve a list of Settlements
.
created_at.gte | string Filter where Example: created_at.gte=2022-09-27T11:21:23 |
created_at.lte | string Filter where Example: created_at.lte=2022-09-27T11:21:23 |
updated_at.gte | string Filter where |
updated_at.lte | string Filter where |
id | string Filter by |
limit | integer The numbers of items to return. Example: limit=10 |
transfer_id | string Filter by a |
funding_transfer_id | string Filter by a |
tags.key | string Filter by the |
tags.value | string Filter by the value of a |
List of Settlement
objects
Authentication information is missing or invalid
Forbidden
Not Acceptable
curl https://finix.sandbox-payments-api.com/settlements/ \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "settlements": [
- {
- "id": "STe74LQe57QJXD2xEssKL3dA",
- "created_at": "2022-10-10T05:00:09.29Z",
- "updated_at": "2022-10-10T12:15:29.76Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDvHGrfeVmB3i7uL78xjemNk",
- "merchant_id": "MU7cXuKj2xx41hhZZi6bZ13A",
- "net_amount": 648811,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 662154,
- "total_fee": 13343,
- "total_fees": 13343,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}, - {
- "id": "STmNNVzeYxC8eC6osqXEGFwf",
- "created_at": "2022-09-27T18:39:02.62Z",
- "updated_at": "2022-09-27T18:45:26.41Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDuqZpDw28f2KK6YuDk4jNLg",
- "merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
- "net_amount": 1492238,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 1525108,
- "total_fee": 32870,
- "total_fees": 32870,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 573
}
}
Retreive the details of a Settlement
.
Settlement
object.
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/settlements/STimypRqs5TXoCDRq2swMFUY \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "id": "STimypRqs5TXoCDRq2swMFUY",
- "created_at": "2022-08-09T17:06:02.99Z",
- "updated_at": "2022-08-09T17:15:25.60Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDuqZpDw28f2KK6YuDk4jNLg",
- "merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
- "net_amount": 2238357,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 2287662,
- "total_fee": 49305,
- "total_fees": 49305,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}
List the funding Transfers
that were created when a Settlement
was approved that have type
CREDIT or DEBIT.
List of Transfer objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/funding_transfers \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "transfers": [
- {
- "id": "TRvQN3v5mhA2Ttc78hzjLV3j",
- "created_at": "2022-10-11T03:25:04.79Z",
- "updated_at": "2022-10-11T03:25:04.79Z",
- "additional_buyer_charges": null,
- "additional_healthcare_data": null,
- "address_verification": null,
- "amount": 13243,
- "amount_requested": 13243,
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "externally_funded": "FALSE",
- "failure_code": null,
- "failure_message": null,
- "fee": 0,
- "fee_type": "CARD_BASIS_POINTS",
- "idempotency_id": null,
- "merchant_identity": "IDddHpRqwf2VsH2XB1fmLfhM",
- "messages": [ ],
- "raw": null,
- "ready_to_settle_at": "2022-10-11T03:25:05.32Z",
- "security_code_verification": null,
- "source": null,
- "state": "SUCCEEDED",
- "statement_descriptor": null,
- "subtype": "PLATFORM_FEE",
- "tags": { },
- "trace_id": "611dcc5f-0622-4ec7-8c8b-b08896456d62",
- "type": "FEE",
- "_links": {
- "application": {
}, - "merchant_identity": {
}, - "payment_instruments": {
}, - "fee_profile": {
}
}
}, - {
- "id": "TR34MdY6eagpEqhtTaP8EBCR",
- "created_at": "2022-10-10T06:32:04.58Z",
- "updated_at": "2022-10-10T06:32:04.58Z",
- "additional_buyer_charges": null,
- "additional_healthcare_data": null,
- "address_verification": null,
- "amount": 19,
- "amount_requested": 19,
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "externally_funded": "FALSE",
- "failure_code": null,
- "failure_message": null,
- "fee": 0,
- "fee_type": "CARD_BASIS_POINTS",
- "idempotency_id": null,
- "merchant_identity": "IDddHpRqwf2VsH2XB1fmLfhM",
- "messages": [ ],
- "raw": null,
- "ready_to_settle_at": "2022-10-10T06:32:05.05Z",
- "security_code_verification": null,
- "source": null,
- "state": "SUCCEEDED",
- "statement_descriptor": null,
- "subtype": "PLATFORM_FEE",
- "tags": { },
- "trace_id": "a79105c7-8b93-4c36-8734-83f02ca0686c",
- "type": "FEE",
- "_links": {
- "application": {
}, - "merchant_identity": {
}, - "payment_instruments": {
}, - "fee_profile": {
}
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 23985
}
}
Remove a Transfer
that makes up a Settlement
.
As long as the Settlement
hasn't been funded, you can remove the Transfer
or an array of Transfers
, along with its corresponding fee
from the encompassing Settlement
.
transfers
can't be deleted.Per the JSON API for deleting a resource, our API doesn't have a response body when removing a
Transfer
from aSettlement
.
No content
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl https://finix.sandbox-payments-api.com/settlements/STmCc8GbjjX33SdymwNhb9Et/transfers \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X DELETE \ -d ' { "transfers": [ "TRr61njQxaa7AJf6E1C3QwCc" ] }'
{- "total": 0,
- "_embedded": {
- "errors": [
- {
- "code": "UNKNOWN",
- "logref": {
- "logref": "string"
}, - "message": "string",
- "_links": {
- "self": {
- "href": "string"
}, - "source": {
- "href": "string"
}
}
}
]
}
}
Retrieve a list of every Transfer
in a Settlement
that has type
DEBIT or REFUND.
List of Transfer objects
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "transfers": [
- {
- "id": "TRvQN3v5mhA2Ttc78hzjLV3j",
- "created_at": "2022-10-11T03:25:04.79Z",
- "updated_at": "2022-10-11T03:25:04.79Z",
- "additional_buyer_charges": null,
- "additional_healthcare_data": null,
- "address_verification": null,
- "amount": 13243,
- "amount_requested": 13243,
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "externally_funded": "FALSE",
- "failure_code": null,
- "failure_message": null,
- "fee": 0,
- "fee_type": "CARD_BASIS_POINTS",
- "idempotency_id": null,
- "merchant_identity": "IDddHpRqwf2VsH2XB1fmLfhM",
- "messages": [ ],
- "raw": null,
- "ready_to_settle_at": "2022-10-11T03:25:05.32Z",
- "security_code_verification": null,
- "source": null,
- "state": "SUCCEEDED",
- "statement_descriptor": null,
- "subtype": "PLATFORM_FEE",
- "tags": { },
- "trace_id": "611dcc5f-0622-4ec7-8c8b-b08896456d62",
- "type": "FEE",
- "_links": {
- "application": {
}, - "merchant_identity": {
}, - "payment_instruments": {
}, - "fee_profile": {
}
}
}, - {
- "id": "TR34MdY6eagpEqhtTaP8EBCR",
- "created_at": "2022-10-10T06:32:04.58Z",
- "updated_at": "2022-10-10T06:32:04.58Z",
- "additional_buyer_charges": null,
- "additional_healthcare_data": null,
- "address_verification": null,
- "amount": 19,
- "amount_requested": 19,
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "externally_funded": "FALSE",
- "failure_code": null,
- "failure_message": null,
- "fee": 0,
- "fee_type": "CARD_BASIS_POINTS",
- "idempotency_id": null,
- "merchant_identity": "IDddHpRqwf2VsH2XB1fmLfhM",
- "messages": [ ],
- "raw": null,
- "ready_to_settle_at": "2022-10-10T06:32:05.05Z",
- "security_code_verification": null,
- "source": null,
- "state": "SUCCEEDED",
- "statement_descriptor": null,
- "subtype": "PLATFORM_FEE",
- "tags": { },
- "trace_id": "a79105c7-8b93-4c36-8734-83f02ca0686c",
- "type": "FEE",
- "_links": {
- "application": {
}, - "merchant_identity": {
}, - "payment_instruments": {
}, - "fee_profile": {
}
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 23985
}
}