Transfers

Retrieve a transfer's status

Retrieve the status for a transfer

get/transfers/{id}/status

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Path parameters

idstring required
Example:tr_z1urYtVFgEebtcj8fxp4v

Unique identifier for the Transfer

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Unique identifier for the Transfer

status'created' | 'successful' | 'pending' | 'failed' required

The current status of this Transfer

Example response

{
  "id": "tr_z1urYtVFgEebtcj8fxp4v",
  "status": "successful"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.