v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB

Payout Services

Get Payout by Reference ID

Payout details service.

get/v1/payment/payouts

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

Acceptable media type(s) 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

{
  "status": {
    "error": {
      "code": "G01",
      "message": "Gateway, payment method not supported"
    }
  },
  "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": {
        "type": "CC"
      }
    }
  },
  "payer": {
    "account_type": "Current Account"
  },
  "payout_id": "5t1bc9001-6b5a-4f21-b5ee-fd32m4f436c6"
}