Skip to main content
POST
/
v1
/
merchants
/
{merchantId}
/
transactions
/
{transactionId}
/
pay
Pay PIX transaction via QR code (Sandbox Only)
curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/transactions/{transactionId}/pay \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payer_company_id": "123e4567-e89b-12d3-a456-426614174002"
}
'
{
  "request_id": "f9b978a6-ab7e-4460-997d-1234567890ab",
  "status": "COMPLETED",
  "amount": 10000
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Path Parameters

​
merchantId
string
required

Merchant/Company ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
transactionId
string
required

Transaction ID containing the PIX QR code

Example:

"123e4567-e89b-12d3-a456-426614174001"

Body

application/json
​
payer_company_id
string
required

ID of the company whose bank account will be used for payment. The payer company must have an active affiliation with the same provider of the transaction to be able to pay.

Example:

"123e4567-e89b-12d3-a456-426614174002"

Response

PIX payment processed successfully

​
request_id
string
Example:

"f9b978a6-ab7e-4460-997d-1234567890ab"

​
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
Example:

"COMPLETED"

​
amount
integer

The transaction's amount in cents (payment is always for the full transaction amount)

Example:

10000