POST/counterparty/{userId}/counterparties/{counterpartyId}/instrument

Create Payment Instrument (Stablecoin - USDC)

Creates a USDC stablecoin withdrawal instrument for a counterparty.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique ID of the user. The user must be active.
`counterpartyId`	string	Required	—	Unique counterparty ID.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`Currency`	string	Required	USDC	Stablecoin currency.
`TransferType`	string	Required	STABLECOIN_WITHDRAW	Transfer type.
`CustomValues.Nickname`	string	Required	—	Display name for the instrument.
`CustomValues.Address`	string	Required	—	Destination wallet address.
`CustomValues.Blockchain`	string	Required	ETH	Blockchain network of the destination wallet.

Example request

{
  "Currency": "USDC",
  "TransferType": "STABLECOIN_WITHDRAW",
  "CustomValues": {
    "Nickname": "Test Stable Coin Creation",
    "Address": "0xa0b8****...****b481",
    "Blockchain": "ETH"
  }
}

{
  "Currency": "USDC",
  "TransferType": "STABLECOIN_WITHDRAW",
  "CustomValues": {
    "Nickname": "Test Stable Coin Creation",
    "Address": "0xa0b8****...****b481",
    "Blockchain": "ETH"
  }
}

ℹ Note

CustomValues for TransferType STABLECOIN_WITHDRAW: Nickname, Address, Blockchain. Retrieve the exact required fields from the Get Required Fields for Instruments endpoint.

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	ID of the newly created stablecoin instrument.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "3727746074356920285"
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "3727746074356920285"
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.