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

Credit Or Debit a Funds Management Account (FMA)

POST
/merchants/{id}/settlement/funds

Used to deposit funds to a connected business bank account or debit card. Can also be used to add funds to a Global Payments Funds Management Account (FMA) from a connected business bank account.

The Bank_Transfer_Return_Notification callback is sent to the URL supplied in an earlier request ({$request.body#/notifications/status_url}); see POST /authentications.

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.

Length1 <= length <= 50
Default"MER_880c34767b184d5e82b10e767201e648"

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"
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

Request Body

application/json

account_name?string

The account name for the account that sent a transfer.

Length1 <= length <= 50
account_id?string

The account identifier for the account that sent a transfer.

Length1 <= length <= 50
type?string

Indicates whether to debit the amount to a bank account/payout card, or credit the amount to the Global Funds Management account.

Length1 <= length <= 50

Value in

  • "DEBIT"
  • "CREDIT"
amount?string

The amount that should be credited or debited. It is always represented in the lowest denomiation of the related currency.

Length1 <= length <= 50
currency?string

The currency of the amount in ISO-4217(alpha-3)

Length3 <= length <= 3
payment_method?string

The payment method available to create transactions with.

  • BANK_TRANSFER - Indicates to transfer funds to or from the connected payout bank account.

  • CARD - Indicates to transfer funds to the "Funds Payout Card."

Length1 <= length <= 50

Value in

  • "BANK_TRANSFER"
  • "CARD"

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/settlement/funds" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "account_name": "718556837_989567",    "account_id": "FMA_bde109d70fb24d78b25fd364317dd9dc",    "type": "DEBIT",    "amount": "500",    "currency": "USD",    "payment_method": "CARD"  }'
{  "id": "FND_ZkGPrJiuVRMCh10VEyInhn0fbTKdfT",  "time_created": "2023-03-10T13:14:48.386Z",  "time_last_updated": "2023-03-10T13:14:48.386Z",  "type": "DEBIT",  "status": "CAPTURED",  "amount": "100",  "currency": "USD",  "payment_method": "BANK_TRANSFER",  "merchant_id": "MER_880c34767b184d5e82b10e767201e648",  "merchant_name": "Curtis_Douglas49",  "account_id": "FMA_bde109d70fb24d78b25fd364317dd9dc",  "account_name": "718556837_989567",  "provider": {    "result": "00",    "message": "Successful"  },  "action_create_id": "ACT_tec6AQFrGKEeFY1BLFDA3cz3wSG69u",  "parent_resource_id": "FND_zeSDfZ9OfM8IWgInQXImc8azdqE2es",  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "FUNDS",    "time_created": "2021-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Download Document POST

Get a Document associated with a Dispute. 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.

Get a Fund GET

Get info about a Funding event on the Global Payments system using the unique id created by Global Payments for that Fund.