Funds Split Reversals
The Funds Split Reversal API helps you reverse an existing Funds Split made to a connected account, either entirely or partially.
Data Retention Policy: You can query and operate Funds Split Reversal resources for a maximum of 2 years since creation.
POST /api/v1/pa/funds_split_reversals/createGET /api/v1/pa/funds_split_reversals/{id}GET /api/v1/pa/funds_split_reversals
Create a Funds Split Reversal
POST /api/v1/pa/funds_split_reversals/create
Initiate a Funds Split Reversal to take money back from a connected account. You must specify a Funds Split as the source of reversal.
When reversing a Funds Split, You can optionally reverse part of it. You can do so as many times as you wish until the entire Funds Split has been reversed. Once entirely reversed, a Funds Split can’t be reversed again. This method will return an error when called on an already-reversed Funds Split, or when trying to reverse more money than is left on a Funds Split.
Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split. Please refer to supported currencies for supported minor units.
Unique identifier of Funds Split on which the Funds Split Reversal is created.
Unique request identifier specified by the merchant. Maximum length is 64.
A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split
Instant when this split reversal is created at
Funds Split unique identifier
Unique identifier for the Funds Split Reversal
A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant in the last operation
Status of this reversal, can be CREATED, RELEASED, SETTLED etc
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/funds_split_reversals/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d",> "funds_split_id": "spt_hkpdkhwr5h1s5nct0l",> "amount": "10",> "metadata": {> "foo": "bar"> }>}'
1{2 "id": "rev_hkpdkhwr5h1375nct0l",3 "request_id": "1b1fa33d-a733-4884-8d45-bba8076c447d",4 "funds_split_id": "spt_hkpdkhwr5h1s5nct0l",5 "amount": "10",6 "status": "CREATED",7 "metadata": {8 "foo": "bar"9 },10 "created_at": "2024-04-09T02:46:19.320490400+00:00"11}
Retrieve a Funds Split Reversal
GET /api/v1/pa/funds_split_reversals/{id}
Retrieve a Funds Split Reversal by unique identifier.
Funds Split Reversal Id.
Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split
Instant when this split reversal is created at
Funds Split unique identifier
Unique identifier for the Funds Split Reversal
A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant in the last operation
Status of this reversal, can be CREATED, RELEASED, SETTLED etc
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/funds_split_reversals/rev_hkpdkhwr5h1375nct0l' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "id": "rev_hkpdkhwr5h1375nct0l",3 "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43",4 "funds_split_id": "spt_hkpdkhwr5h1s5nct0l",5 "amount": 10,6 "status": "RELEASED",7 "metadata": {8 "foo": "bar"9 },10 "created_at": "2024-04-09T02:46:19.320490400+00:00"11}
List all Funds Split Reversals
GET /api/v1/pa/funds_split_reversals
List all Funds Split Reversals.
Unique identifier of which funds_split this funds_split_reversal would be created from.
Page number starting from 0.
Number of Fund Split Reversals to be listed per page. Default value is 10. Maximum is 1000. The value greater than the maximum will be capped to the maximum.
A flag which identifies whether there are more results.
List items
Amount of this reversal. You can only reverse up to the unreversed amount remaining of the Funds Split
Instant when this split reversal is created at
Funds Split unique identifier
Unique identifier for the Funds Split Reversal
A set of key-value pairs that you can attach to the Funds Split Reversal. You can specify up to 50 keys with key names up to 50 characters long and values up to 500 characters long.
Unique request identifier specified by the merchant in the last operation
Status of this reversal, can be CREATED, RELEASED, SETTLED etc
| Error status | Description |
|---|---|
| 400 | Bad Request. Possible error codes: |
| 401 | Unauthorized. Possible error codes: |
| 403 | Forbidden |
| 404 | Not Found. Possible error codes: |
| 500 | Server Error. Possible error codes: |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/pa/funds_split_reversals' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "has_more": false,3 "items": [4 {5 "id": "rev_hkpdkhwr5h1375nct0l",6 "request_id": "ff232fa1-3ebe-4b59-8d96-ea7b6499ef43",7 "funds_split_id": "spt_hkpdkhwr5h1s5nct0l",8 "amount": 10,9 "status": "CREATED",10 "metadata": {11 "foo": "bar"12 },13 "created_at": "2024-04-09T02:46:19.320490400+00:00"14 }15 ]16}