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": "[email protected]",
"original_amount": "20,00",
"fee": "2,0",
"tax": "1,3",
"additional_value": "0",
"value": "21,70",
"payer_info": []
}
Params descriptions
Param | Description |
---|---|
latam_id | Order ID into the Sulpayment’s system |
code | The order ID from your system |
status | The order’s current status |
name | Customer’s name |
Customer’s email | |
original_amount | Value excluding taxes and fees |
fee | Sulpayment's fee in the order in BRL |
tax | Sulpayment's tax in the order in BRL |
additional_value | Additional charge to the customer in BRL |
value | Value adding tax and fee or additional_value |
reason | Default message explaining the status, if necessary; default: null |
payer_info | A hashed object that contains the payer's information |
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 |
---|---|
initial |
Order created. Waiting for the customer to complete the checkout (redirect). |
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 |
Cancellation Scenarios
Scenario | code |
reason |
---|---|---|
Month's limit reached | AML-01 | AML-01: Customer has reached month’s purchase limit |
Semester's limit reached | AML-02 | AML-02: Customer has reached semester’s purchase limit |
Suspicious case | GL-01 | GL-01: Suspicious Case - Customer under investigation for unusual activities |
Legacy | GL-02 | GL-02: Legacy case. Please check with Gowd Compliance team |
Other reasons | GL-03 | GL-03: Customer blocked by Gowd Compliance team for a custom reason. Contact Gowd Compliance for details |
RFI | BL-01 | BL-01: RFI - Customer under investigation by Gowd Compliance team |
Dispute | BL-02 | BL-02: Dispute - Customer or issuing bank disputed a transaction payment |
Multiple disputes | BL-03 | BL-03: Disputes - Multiple disputes opened by the Customer or their issuing bank |
Antifraud | BL-04 | BL-04: Antifraud - Customer blocked by the Gowd antifraud engine |
Internal decision | BL-05 | BL-05: Customer blocked by Gowd Compliance team decision |
Judicial decision | BL-06 | BL-06: Customer blocked by judicial decision |
Judicial/administrative processes | BL-07 | BL-07: Customer blocked due to judicial or administrative processes |
BL - Other reason | BL-08 | BL-08: Customer blocked by Gowd Compliance team for a custom reason. Contact Gowd Compliance for details |
MED | BL-09 | BL-09: MED - Customer blocked due to a MED dispute |
Payer blocked | BL-10 | BL-10: Payer blocked by LG Compliance team decision |
Partner restriction | CR-01 | CR-01: Customer blocked by partner request |
Payment Method restriction | CR-02 | CR-02: Customer blocked from transacting with this payment method |
Maximum number of orders of the day reached | AF-01 | AF-01: Customer has reached the maximum number of daily orders |
Maximum daily purchase amount reached | AF-02 | AF-02: Customer has reached the maximum purchase amount for the day |
Maximum amount for first order of the day reached | AF-03 | AF-03: Customer has reached the maximum purchase amount for the first order of the day |
Divergence of documents | NM-01 | NM-01: Customer’s document does not match the payer’s |
Divergence of names | NM-02 | NM-02: Customer’s name does not match the payer’s |