2. Pay Out Response

2.1 Successful Response

In case of success, you will receive a successful response as below:

{
"transactionId": 0,
"merchantInvoiceId": "1632839298187",
"currency": "USD",
"amount": 10.00,
"convertedCurrency": "BRL",
"convertedAmount": 54.67,
"feeAmount": 0.0,
"status": 102,
"message": "pending",
"customerEmail": "[email protected]",
"hash": "878F6A389131E58AE25210CE335A1A9BCB594EAE9F2",
"process": "PayOut"
}

After that, PayOut will be processed and you will receive a final confirmation as soon as it is done.

2.2 Unsuccessful Response

In case of failure, you will receive an unsuccessful response as below:

{ 
    "code": 400,
    "message": "error message" 
}

WARNING !!

If two requests are made within an interval of less than 2 minutes, the API will return the following fail response:

{
"code": 409,
"message": "transaction_in_processing"
}

In these cases, PayOut will not be processed, and you will not receive any further confirmation.

2.3 List of Possible Errors

• HTTP Status Code 400 (Bad Request):

  • PROCESSING_ERROR: An error occurred during the processing of the transaction. It's advisable to review the request and try again.

  • TRANSACTION_IN_PROCESSING: The transaction is currently in processing. It's advisable to wait for the current processing to complete.

  • MERCHANT_NOT_FOUND: The specified merchant was not found. Ensure that a valid merchant identifier is provided.

  • CUSTOMER_NOT_FOUND: The specified customer was not found. Ensure that a valid customer identifier is provided.

  • INVALID_REQUEST: The request is invalid. Review the request body and ensure all required parameters are provided and are correct.

  • MERCHANT_NOT_AUTHORIZED: The merchant is not authorized to perform the requested action. Verify the merchant's credentials and permissions.

  • INVALID_EMAIL: The provided email address is invalid. Ensure that a valid email address is provided.

  • INVALID_CUSTOMER_MAIN_ID: The provided customer main ID is invalid. Ensure that a valid customer main ID is provided.

  • INVALID_CONFIRMATION_URL: The provided confirmation URL is invalid. Ensure that a valid confirmation URL is provided.

  • INVALID_REQUEST_CURRENCY: The requested currency is invalid. Ensure that a valid currency is provided.

  • INVALID_BANK_ACCOUNT_DATA: The provided bank account data is invalid. Ensure that correct and complete bank account data is provided.

  • MERCHANT_ACCOUNT_NOT_LIVE: The merchant account is not live. Ensure that the merchant account is active and live.

  • MERCHANT_IP_NOT_AUTHORIZED: The IP address of the merchant is not authorized. Ensure that requests are made from authorized IP addresses.

  • INVALID_SECURITY_HASH: The provided security hash is invalid. Ensure that a valid security hash is provided.

  • MINIMUM_AMOUNT_NOT_REACHED: The minimum amount for the transaction has not been reached. Ensure that the transaction amount meets the minimum requirement.

  • MAXIMUM_AMOUNT_EXCEEDED: The maximum amount for the transaction has been exceeded. Ensure that the transaction amount is within the allowed limit.

  • CUSTOMER_ACCOUNT_HAS_BEEN_LOCKED: The customer account has been locked. Contact support for further assistance.

  • CPF_ANALYSIS_FAILED: The CPF analysis failed. Ensure that valid CPF information is provided.

  • INFO_CPF_NOT_VALIDATED: The information provided for CPF validation did not pass. Ensure that correct CPF information is provided.

  • CUSTOMER_ACCOUNT_MUST_BE_APPROVED: The customer account must be approved before proceeding. Contact support for further assistance.

  • MAIN_ID_LOCKED_BY_MERCHANT: The main ID has been locked by the merchant. Contact support for further assistance.

  • MONEY_OUT_LIMIT_REACHED: The money out limit has been reached. Review the transaction amount and ensure it's within the allowed limit.

  • INVALID_PIX_KEY: The provided PIX key is invalid. Ensure that a valid PIX key is provided.

  • INVALID_PHONE_NUMBER: The provided phone number is invalid. Ensure that a valid phone number is provided.

  • CUSTOMER_MONEY_OUT_LIMIT_FOR_PAYMENT_METHOD_TYPE_REACHED: The customer money out limit for the payment method type has been reached. Review the transaction amount and payment method.

  HTTP Status Code 503 (Service Unavailable):

  • Retry-After {Datetime}: The service is currently unavailable. It's advisable to retry the transaction after the specified datetime.