Get PIX Payout by external ID

GET

/v1/pix/payout/external_id/{id}

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200Success

application/json

Body

🟠401Unauthorized

🟠400Bad request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.rivuspay.digital/v1/pix/payout/external_id/' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "status": "pending",
        "amount": 10,
        "tax_id": "11122233344",
        "description": "string",
        "pix_type": "cpf",
        "pix_key": "11122233344",
        "e2e": "string",
        "payer": {
            "tax_id": "string",
            "name": "string",
            "bank_ispb": "string",
            "account_type": "string",
            "account_branch": "string",
            "account_number": "string"
        },
        "receiver": {
            "tax_id": "string",
            "name": "string",
            "bank_ispb": "string",
            "account_type": "string",
            "account_branch": "string",
            "account_number": "string"
        }
    }
}

Get PIX Payout by ID

Get balance