KOkoin
Payout Services

Get Payout by Reference ID

Changed on

Payout details service.

get/v1/payment/payouts

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/payouts
  • Auth
    none declared. Required headers: Content-Type, Accept

Query parameters

reference_idstring required

Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction)

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json

Response

Payout details response

descriptorstring

Text send to client. Maximum of 140 characters.

payout_idstring

Payout Id returned by Create Payout API.

codestring

Standardized error code (applies only for error cases)

messagestring

Message associated with the error code (applies only for error cases)

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "descriptor": "From Mike to Maria's birthday present",
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000PO",
    "amount": {
      "currency_code": "BRL"
    }
  },
  "payment_method": {
    "code": "PAYOUTS",
    "recipient": {
      "full_name": "Box Jhon",
      "account": {
        "code": "0123456789",
        "type": "CC"
      }
    }
  },
  "payer": {
    "account_code": "0123456789",
    "account_type": "Current Account"
  },
  "payout_id": "5t1bc9001-6b5a-4f21-b5ee-fd32m4f436c6"
}

Changes

  • 1e3734785750Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      the // response's property pattern was changed from ^\d{1,10}\.\d{2}$ to d{1,10}.d{2} for the status