Get payout

Getting a payout by id

Get payout

GET {API_BASE_URL}/v2/merchants/payouts/{id}

Returns data about an existing payout.

Path Parameters

Name	Type	Description
id*	string	Payout id

Headers

Name	Type	Description
x-merchant-id*	string
x-timestamp*	number
x-signature*	string	x-signature

200 Payout object

{
  "id": "8ea802ab-267f-4145-8726-eba4d7d07da5",
  "reference_id": "id-in-merchant-system-485",
  "status": "executed",
  "payment": {
    "amount": 49.23,
    "currency": "EUR"
  },
  "fee": {
    "amount": 0.3,
    "currency": "EUR"
  },
  "created_at": "2023-02-27T17:59:39.945246",
  "updated_at": "2023-02-27T17:59:39.945246",
  "expires_at": "2023-02-27T18:04:15.493103",
  "error_code": "string",
  "error_message": "string"
  }

404: Not Found Payout does not exist

401: Unauthorized Signature validation failed

Your signature generation may not be set up correctly or you are using an incorrect public or secret key.

403: Forbidden Access denied

Your merchant account may not have been fully set up. Please contact us for assistance.

422: Unprocessable Entity Invalid request

You might have issue with the integration. Please contact us and provide your request payload for investigation.

Example

curl -H 'Content-Type: application/json' \
-H 'x-merchant-id: dev_pub_fb1dad5f-5982-4e1a-ac2f-62a7daaa7148' \
-H 'x-timestamp: 1601234567' \
-H 'x-signature: da09fe246312d0b1c2682d39b34d5efeb8925617710ec9a752d9a9dc39856945' \
https://api.dev.kitopay.com/api/v2/merchants/payouts/db2e9e8c-56ec-435b-80b8-668e1387c993

Getting a payout by reference_id

Get payout

GET {API_BASE_URL}/v2/merchants/payouts/?reference_id=merchant-internal-id-123

Returns data about an existing payout.

Query Parameters

Name	Type	Description
reference_id*	string	Your internal identifier that you used when creating a payout

Headers

Name	Type	Description
x-merchant-id*	string
x-timestamp*	number
x-signature*	string	x-signature

200 Payout object

{
  "id": "8ea802ab-267f-4145-8726-eba4d7d07da5",
  "reference_id": "id-in-merchant-system-485",
  "status": "executed",
  "payment": {
    "amount": 49.23,
    "currency": "EUR"
  },
  "fee": {
    "amount": 0.3,
    "currency": "EUR"
  },
  "created_at": "2023-02-27T17:59:39.945246",
  "updated_at": "2023-02-27T17:59:39.945246",
  "expires_at": "2023-02-27T18:04:15.493103",
  "error_code": "string",
  "error_message": "string"
  }

404: Not Found Payout does not exist

401: Unauthorized Signature validation failed

Your signature generation may not be set up correctly or you are using an incorrect public or secret key.

403: Forbidden Access denied

Your merchant account may not have been fully set up. Please contact us for assistance.

422: Unprocessable Entity Invalid request

You might have issue with the integration. Please contact us and provide your request payload for investigation.

Example

curl -H 'Content-Type: application/json' \
-H 'x-merchant-id: dev_pub_fb1dad5f-5982-4e1a-ac2f-62a7daaa7148' \
-H 'x-timestamp: 1601234567' \
-H 'x-signature: 33e5dfa5afaad37f153a3297b6022a9791b1334fa824ce206b32fb8207378084' \
https://api.dev.kitopay.com/api/v2/merchants/payouts/?reference_id=merchant-internal-id-123