Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Transactions

Split a Transaction Amount

POST
/transactions/{id}/split

Transfer part of a transaction amount, executed by a merchant, to the partner account. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

A unique identifier that is used to identify and reference an instance of this resource. It is generated by Global Payments to identify the transaction and must be used to action that transaction in future.

Length1 <= length <= 50

Header Parameters

X-GP-Idempotency?string

Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.

Length1 <= length <= 50
X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Request Body

application/json

transfers?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/transactions/TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d/split" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "transfers": [      {        "account_id": "TRA_31dbc9d58a26458386d927db02e38094",        "recipient_account_id": "FMA_dd7976feccd94906ac9995628d27a81e",        "reference": "merchant identifier",        "transaction_amount_percentage": "3.1",        "amount": "10",        "description": "split 1"      }    ]  }'
{  "id": "TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "time_created": "2026-05-03T21:23:39.718Z",  "status": "CAPTURED",  "country": "US",  "currency": "USD",  "type": "SALE",  "amount": "11099",  "merchant_id": "MER_A6A1EC44522F96630ABEA17A",  "account_id": "TRA_86920f927028745yt34d077d88beb29b",  "merchant_name": "ABC INDUSTRIES",  "account_name": "transaction_processing",  "reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e",  "payment_method": {    "result": "string",    "message": "string"  },  "transfers": [    {      "id": "TRF_HP1XBe4tlWGp4ikejDmYrVFx2SMeS3",      "time_created": "2023-03-10T13:14:48.386Z",      "status": "SUCCESS",      "amount": "10000",      "merchant_id": "MER_880c34767b184d5e82b10e767201e648",      "merchant_name": "Curtis_Douglas49",      "account_id": "FMA_86920f927028745yt34d077d88beb29b",      "account_name": "718556837_989567",      "recipient_merchant_id": "MER_880c34767b184d5e82b10e767201e648",      "recipient_merchant_name": "Curtis_Douglas49",      "recipient_account_name": "718556837_989567",      "recipient_account_id": "FMA_b29c209e25db47ea8d9ef9f24ef29254",      "reference": "my_reference",      "description": "Transfer 1",      "provider": {        "result": "00",        "message": "SUCCESS"      }    }  ],  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "AUTHORIZE",    "time_created": "2026-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Confirm a Transaction POST

For certain transactions created using non-card based payment methods (for example, PayPal), merchants are required to confirm that the transaction has completed in order for funds to be transferred. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Synchronize a Device POST

Synchronize a physical device to successfully transaction process.(Availability in production depends on your live configuration.)