Information about payout

To receive data about a specific PayOut transaction, a GET request is used, including the unique transaction ID. This request returns information about the transaction's status, amount, recipient requisites and other parameters. Authorization is performed using your cashier’s API key.

This section describes the process of requesting PayOut information using the API. You will be able to get detailed information about each transaction, including its status, amount, and recipient requisites. You need to provide the request ID and authorize using the cashier's API key to send the request.

Request

GET https://repay.cx/payout_api/v1/external/payout_deals/{merchant_deal_id}

Parameters

Name	Type	Description
api-key	string	Your cashier's API key

Headers

Name	Type	Description
merchant_deal_id	string	Unique identifier of transaction (Merchant deal ID).

cURL Example

curl -X GET 'https://repay.cx/payout_api/v1/external/payout_deals/{merchant_deal_id}' \
-H 'api-key: your_api_key'

Response

Example of a successful response

You will receive a 200 OK status and the request information if the request is processed successfully.

{
    "status_code": 200,
    "id": "20f8286a-b181-4bb0-9e3b-f87ca4926dc9",
    "order_id": "0001",
    "amount": "1000",
    "recipient_type": "card_number",
    "recipient": "2202********3722",
    "state": "completed",
    "created_at": "2024-09-25T12:00:00Z",
    "updated_at": "2024-09-25T13:00:00Z"
}

Name	Type	Description
status_code	string (number)	Status code of transaction (for example, 200 for successful request)
id	string	Unique request identifier in the system (System deal ID)
order_id	string	Unique identifier of the request on the merchant's side (Merchant deal ID)
amount	string (number)	Amount of transaction in fiat currency
recipient_type	string	Recipient's requisites type (for example, card_number)
recipient	string	Recipient's requisites (in the case of a card-to-card transfer, only the first 6 and the last 4 digits of the card are displayed)
state	string	Current status of transaction (for example, completed, processing)
created_at	string	Creation time of transaction
updated_at	string	The time of the last transaction modification (for example, the moment transaction is completed)

Example of an unsuccessful response

You will receive a response with an error code and explanation if the request is processed incorrectly.

{
  "status_code": 400,
  "error": "Invalid merchant_deal_id"
}

Possible errors

Code	Name	Description
400	Bad Request	Incorrect request (for example, the request ID is incorrect)
401	Unauthorized	Authorization failed, API key is incorrect
404	Not Found	Application with specified ID not found
500	Server Error	Internal server error