Create PIX Payout

POST

/v1/pix/payout

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 ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.rivuspay.digital/v1/pix/payout' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tax_id": "string",
    "pix_type": "cpf",
    "pix_key": "11122233344",
    "amount": 10,
    "external_id": "q5yffgl1chpme4wotcxy6xdp",
    "meta": {
        "ip": "192.168.0.1",
        "name": "string",
        "email": "string",
        "phone": "string"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "status": "pending",
        "tax_id": "11122233344",
        "pix_key": "11122233344",
        "pix_key_type": "cpf"
    }
}

Get PIX Payin by external ID

Get PIX Payout by ID