Payout
Merchants can transfer money to their collaborators using the payout service with Pix as the payment method.
Status
Status | Reason | Description |
|---|---|---|
Opened | The order was created but not yet published in the bank. | |
Published | The order was published and is now awaiting confirmation. | |
Transferred | The bank confirmed the transaction. The order finished successfully. | |
Failed | Rejected | Something went wrong the payout order failed for rejected problems. |
Failed | ConnectionRefused | Something went wrong the payout order failed for communication problems. |
When the order status changes a webhook notification will be sent.
Testing environment
In order to test all scenarios in a testing environment, you can use the order payment_key to force the order status in the create payout response. For example, if the order payment_key is "mock_error_chave" the order status will be "Published", and after a couple of minutes, it will change to "Failed". In the table below you can find other options.
Payment_key | Response status | Status change |
|---|---|---|
Opened | Published --> Failed | |
Opened | Published --> Transferred | |
Published | Failed | |
Any other [email protected] | Published | Transferred |
When the order status changes a webhook notification will be sent.