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

Transfer Funds

POST
/merchants/{id}/transfers

Move funds from one merchant's fund management account to another merchant's fund management account.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

A unique identifier for the merchant set by Global Payments.

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

account_id?string

The account identifier for the account that sent a transfer.

Lengthlength <= 50
account_name?string

The account name for the account that sent a transfer.

Lengthlength <= 50
recipient_account_id*string

The account identifier for the account that recieved a transfer.

Lengthlength <= 50
recipient_account_name?string

The account identifier for the account that recieved a transfer.

reference*string

A label on the GP API platform that further identifies the instance fo the resource. This is intended to be unique but GP API does not polic its uniqueness.

Lengthlength <= 50
amount*string

The amount that is being transferred. Represented in the lowest denomination of the currency (i.e. $100.00 = 10000

Lengthlength <= 50
description*string

The description of the transfer

Lengthlength <= 50
usable_balance_mode*string

The balance from which the transfer should pull. The transfer will always use avaialble funds first, and may, as directed by this field, pull from the pending balance.
* AVAILABLE_BALANCE - indicates that a transfer will pull only from available funds in the funds management account.
* AVAILABLE_AND_PENDING_BALANCE - indicates the transfer will pull first from the available balance, and then from the pending balance of the funds management account, if needed.

Lengthlength <= 50
Default"AVAILABLE_BALANCE"

Value in

  • "AVAILABLE_BALANCE"
  • "AVAILABLE_AND_PENDING_BALANCE"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/merchants/MER_880c34767b184d5e82b10e767201e648/transfers" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "recipient_account_id": "FMA_b29c209e25db47ea8d9ef9f24ef29254",    "reference": "1234",    "amount": "10000",    "description": "Transfer 1",    "usable_balance_mode": "AVAILABLE_BALANCE"  }'
{  "id": "TRF_U3bZFd2jL98L0XacplaUvPSSDhFI2J",  "time_created": "2023-03-10T13:14:48.386Z",  "time_last_updated": "2023-03-10T13:14:48.386Z",  "type": "TRANSFER",  "status": "SUCCESS",  "amount": "10000",  "usable_balance_mode": "AVAILABLE_BALANCE",  "merchant_id": "MER_880c34767b184d5e82b10e767201e648",  "merchant_name": "Curtis_Douglas49",  "account_id": "FMA_bde109d70fb24d78b25fd364317dd9dc",  "account_name": "718556837_989567",  "recipient_merchant_id": "MER_880c34767b184d5e82b10e767201e648",  "recipient_merchant_name": "Curtis_Douglas49",  "recipient_account_id": "FMA_b29c209e25db47ea8d9ef9f24ef29254",  "reecipient_account_name": "718556837_989567",  "reference": "1234",  "description": "Transfer 1",  "provider": {    "result": "0",    "message": "SUCCESS"  },  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "TRANSFER_SINGLE",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Release a Transaction POST

This request will return a transaction to it's previous state before it was set to to PENDING_REVIEW (HELD). If a transaction is set to PENDING_REVIEW (Held), the release request will return the transaction to its original status. For example, if a transaction was set to automatically capture (capture_mode=AUTO), then the release request will return it to a status of CAPTURED. If you're using differect capture_modes, MULTIPLE or LATER, the transaction will simply return to the PREAUTHRORIZED status. Transactions that are held must be released before they are captured. This functionality is only available for Card Not Present (CNP) transactions in the UK, US, CA and EU.

Reverse A Transfer POST

Reverse a Transfer This will reverse a Transfer. The funds from the transfer will be returned to the initiating merchant.