Order

Postback notification about order updates.

Every time the status of a transaction is changed, your system will receive a notification from ours, so that you are informed of the change.

POST /v1/postback
Host: your_payback_notification_url.com
Content-Type: application/json

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "code": "88",
  "status": "paid",
  "reason": "",
  "name": "Customer’s name",
  "email": "customer@email.com",
  "original_amount": "20.00",
  "fee": "2.0",
  "tax": "1.3",
  "additional_value": "0",
  "value": "21.70",
  "payer_info": {
    "name": "Payer's Name",
    "bank_code": "90646",
    "bank_account": "010101010101010101"
  }
}

Params Descriptions

Param	Description	Value Type
latam_id	Order ID into the Sulpayments’s system	String
code	Order reference in your system	String
status	The order’s current status	String
name	Customer’s name	String
email	Customer's email address	String
original_amount	Value excluding taxes and fees	Decimal
fee	Latam's fee in the order in BRL	Decimal
tax	Latam's tax in the order in BRL	Decimal
additional_value	Additional charge to the customer in BRL	Decimal
value	Total order value	Decimal
reason	Reason in case of failing order; Default: null	String
payer_info.name	Payer's name	String
payer_info.bank_code	Payer’s bank identifier	String
payer_info.bank_account	Payer’s CLABE (bank account number)	String

We expect your system to return a status code of 200. If not, we will attempt to retry 5 more times.

Status meanings

Status	Meaning
canceled	Order was canceled by reasons like: Manual analysis, fraud, etc
waiting_payment	Waiting for the customer to make the payment
expired	Order was not paid at the available time
analysis	The order is being analyzed by our team
paid	The order has been paid but can still be changed if the final field is not True
reversed	The order was reversed, and funds were returned to the customer