Endpoints

https://api.ebanx.com/ws/payout/commit

https://sandbox.ebanx.com/ws/payout/commit

HTTP Method

POST

Response

JSON

This method allows you to commit a payout, starting the payment process, without having to wait the cancellation time. The payout have to be in a status equal to OP and within the cancellation time.

Request parameters

integration_key

string, length 100, required

Your unique and secret integration key.

external_reference

string, length 6-40, optional*

The payout unique ID provided by you.

uid

string, 50 length, optional*

The payout uid (EBANX unique identifier).

* You have to send either the external_reference or the uid

This method call will return a JSON object with the commit operation result.

Response parameters

type

string

The type of the response (success, api_error, authentication_error, invalid_request_error, or request_error).

message

string

The response message.