POST /settlements
GET /settlements
GET /settlements/{id}
GET /settlements/id/funding_transfer
DEL /settlements/{id}/transfers
POST /settlements/{id}/transfers
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 |
amount | integer Filter by an amount equal to the given value. |
amount.gt | integer Filter by an amount greater than. |
amount.gte | integer Filter by an amount greater than or equal. |
amount.lt | integer Filter by an amount less than. |
amount.lte | integer Filter by an amount less than or equal. |
status | string Filter by the status of the
Settlements are APPROVED. For more information, see Payouts.
|
transfer_id | string Filter by a |
funding_transfer_id | string Filter by a |
List of Settlement
objects
Authentication information is missing or invalid
Forbidden
Not Acceptable
curl "https://finix.sandbox-payments-api.com/settlements/" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "_embedded": {
- "settlements": [
- {
- "id": "ST7R7mHjHq3ywG4vGa9cYe9b",
- "created_at": "2023-07-14T09:10:02.91Z",
- "updated_at": "2023-07-15T07:15:58.36Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDvHGrfeVmB3i7uL78xjemNk",
- "merchant_id": "MU7cXuKj2xx41hhZZi6bZ13A",
- "net_amount": 8329,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 9252,
- "total_fee": 923,
- "total_fees": 923,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}, - {
- "id": "SThN7W7iDZM4mhGXqPDaVojn",
- "created_at": "2022-12-21T22:05:08.10Z",
- "updated_at": "2022-12-22T07:15:56.22Z",
- "application": "APgPDQrLD52TYvqazjHJJchM",
- "currency": "USD",
- "destination": null,
- "funds_flow": null,
- "identity": "IDuqZpDw28f2KK6YuDk4jNLg",
- "merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
- "net_amount": 648211,
- "payment_type": null,
- "processor": "DUMMY_V1",
- "status": "AWAITING_APPROVAL",
- "tags": { },
- "total_amount": 661854,
- "total_fee": 13643,
- "total_fees": 13643,
- "type": "MERCHANT_REVENUE",
- "_links": {
- "application": {
}, - "funding_transfers": {
}, - "transfers": {
}, - "reversals": {
},
}
}, - {
- "id": "STsdvwKDyZq3gwZi5upuAETj",
- "created_at": "2022-12-21T22:00:06.57Z",
- "updated_at": "2022-12-22T07:15:55.04Z",
- "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": {
},
}
}
]
}, - "_links": {
}, - "page": {
- "limit": 100,
- "next_cursor": "STsdvwKDyZq3gwZi5upuAETj"
}
}
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/STvUfBLbCUsun2KFoTuxR2j1" \ -H "Finix-Version: 2022-02-01" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "id": "STvUfBLbCUsun2KFoTuxR2j1",
- "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": {
},
}
}
Close an accruing settlement
.
Finix, by default, creates accruing settlements
then closes them based on your payout configurations. Use this endpoint to manually close a specific 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.Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Settlement
object.
Authentication information is missing or invalid
Forbidden
Authentication information is missing or invalid
Not Acceptable
{- "id": "STvUfBLbCUsun2KFoTuxR2j1",
- "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 "Finix-Version: 2022-02-01" \ -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": {
- "limit": 100,
- "next_cursor": "TRvynw5NU1Uo6TB5USyhbzCx"
}
}
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/json" \ -H "Finix-Version: 2022-02-01" \ -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 "Finix-Version: 2022-02-01" \ -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": {
- "limit": 100,
- "next_cursor": "TRvynw5NU1Uo6TB5USyhbzCx"
}
}