Process Card Settlement Split Payouts
POST /cardpayments/v1/accounts/account_id/auths/authorization_id/settlements
As with a standard card settlement, to process a settlement involving Split Payouts you must refer to the original authorization ID and POST your request to the settlement endpoint.
Before trying the example, you should:
- Replace the account number (89987201) in the URL with the test account number you received.
- Replace the API key (after the -u) with the API key you received.
curl -X POST https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/6ce78961-5989-4c4b-ad68-5f5af506143e/settlements \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H 'Content-Type: application/json' \
-d ' {
"merchantRefNum": "merchantRef_2014_04_11_05",
"amount": 5000,
"splitpay": [
{
"linkedAccount": "123124124",
"percent": 5.31
},
{
"linkedAccount": "767862873",
"amount": 500
}
]
}'
If you do not specify a total amount for settlement, the entire amount remaining on the authorization will be settled by default.
The splitpay object is an array of linked accounts, each of which has the following attributes
| Value | Type | Required? | Description | Example |
|---|---|---|---|---|
| linkedAccount | string | Yes | The ID of the linked account. This account must already be linked to the merchant account. | 123124124 |
| percent | number | Either percent or amount is required, but not both. | The percentage of the total transaction amount to transfer to the linked account, to up to two decimal places. The total percentage to all linked accounts cannot exceed 100%. | 5.31 |
| amount | integer | The amount to transfer to the linked account in minor currency units. The total amount to all linked accounts cannot exceed the transaction total. | 500 |
{
"links": [
{
"rel": "self",
"href": "https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/settlements/6ddbc05a-ff40-4dc1-b2d3-f200934dfdde"
}
],
"id": "6ddbc05a-ff40-4dc1-b2d3-f200934dfdde",
"merchantRefNum": "merchantRef_2014_04_11_05",
"txnTime": "2017-04-11T14:04:36Z",
"status": "PENDING",
"amount": 5000,
"availableToRefund": 0,
"splitpay": [
{
"linkedAccount": "123124124",
"percent": 5.31,
"amount": 266
},
{
"linkedAccount": "767862873",
"amount": 500
}
]
}
A pending settlement is created. For most account configurations, the settlement remains pending until it is batched at the end of the day. You can cancel a settlement while it has the status of Pending, in which case the customer is not charged. However, after the settlement has been batched, you cannot cancel it, and you will need to refund the purchase.
The splitpay object in the response is an array containing one or more linked account objects:
| Value | Type | Required? | Description | Example |
|---|---|---|---|---|
| amount | integer | Yes | The amount to transfer to the linked account in minor currency units. This is either the "amount" (if specified) in the request or - if "percent" was specified - the result of the percentage calculation. | 505 |
| linkedAccount | string | Yes | The ID of the linked account. This account must already be linked to the merchant account. | 123124124 |
| percent | number | No | The "percent" (if specified) in the request for the linked account, which is the percentage of the total transaction amount to transfer to that account. This is not returned if an "amount" was specified in the request. | 5.25 |
See our API Reference section for a list of all the JSON attributes and types available in the settlement object.