Rivus Pay
  1. Payin
Rivus Pay
  • Authentication
    • Intro
    • Get Access Token
      POST
  • PIX Payments
    • Intro
    • Payin
      • Create PIX Payin
        POST
      • Get PIX Payin by ID
        GET
      • Get PIX Payin by external ID
        GET
    • Payout
      • Create PIX Payout
      • Get PIX Payout by ID
      • Get PIX Payout by external ID
  • Balance
    • Get balance
      GET
  • Webhooks
    • Intro
    • Webhook app portal link
      POST
  1. Payin

Create PIX Payin

POST
/v1/pix/payin

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 ********************
or
Query Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠401Unauthorized
🟠400Bad request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.rivuspay.digital/v1/pix/payin?gen_base_64=true' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tax_id": "11122233344",
    "amount": 10,
    "external_id": "1710a201-53f5-408f-bfeb-c120a4e69cb4",
    "meta": {
        "ip": "192.168.0.1",
        "name": "string",
        "email": "string",
        "phone": "string"
    }
}'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "mf6ivg2h4zppbjvq4kjc0ary",
        "created_at": "2024-03-28T18:00:00.278279Z",
        "status": "pending",
        "amount": 20,
        "tax_id": "11122233344",
        "pix_qr_code_base64": "iVBORw0KGgoAAAANSUhEUgAAASIAAAEiAQAAAAB1xeIbAAABUUlEQVR4nO3ZwQ2DMAwFUEsZgJFYnZEYoJKLHZskCLU95HOovg8IhcfJtZ1Q0R9iEyqqf1O7RKzHXazvRXO1UAFVqU9cyaov84da01MhlSeigshVyZeonlFeHV4si1I9q44MXV6igqvoTKa2Cj70L6qJSsZ+lJcIKqBqYZ3JMnQNKpTybCw2jJdYjamQxUKFUyL9SgP1Tqmgqs6Cmiavjj0uVGDlv39PjqfJtqMad+NuiGq20mhKWRN2+tU8BbSJTIVRecmB4KcAizYVqECqZaOWQ3vTRgMVTOUE6GaB74u8UXlQoZTqee4SiWfDqYwKqSKSyrglooKpLht9XiJhN98nqOapolkiAfrkDFOBar6SOoz1/OiQueqqgwqq9ljO/7mKDtVBhVS5ETp3p3fVQTVVRWfS3AhZnVy/uFEhVJvDVh2Xw/Dt3KaapL4HFdWfqTds0ba4wurskAAAAABJRU5ErkJggg==",
        "pix_dynamic_code": "5098745656465br.gov.bcb.pix0115681260494670520400065489745613802BR5914Test6006Cidade621505110816049467063049481"
    }
}
Previous
Intro
Next
Get PIX Payin by ID