Payment Services
Get Payment by Reference ID
Payment details service.
get/v1/payment/orders
Query parameters
reference_idstring required
Transaction identifier, generated by client. (Maximum of 50 characters - Unique per transaction).
Headers
Content-Typestring required
The Media type of the body of the request. Default value for payment provider protocol is application/json
Acceptstring required
Acceptable media type(s) for the response. Default value for payment provider protocol is application/json
Response
Payment details response
Example response
{
"store": {
"code": "SBXSTORE"
},
"transaction": {
"reference_id": "REF0000001",
"business_id": "BIZ0000001",
"account": "SBXSTORE",
"amount": {
"currency_code": "BRL",
"value": 1500.56
},
"provider_reference": {
"tx_id": "20000000000000026628140042292",
"end_to_end_id": "E0036030520211216092957cb99ed693"
}
},
"order_id": "9dd3f765-a51a-49d8-b6af-a51d5a0b3f7f",
"status": {
"error": {
"code": "G01",
"message": "Gateway, payment method not supported"
}
},
"locations": [
{
"url": "pix.example.com/qr/9d36b84f-c70b-478f-b95c-12729b90ca25"
}
],
"payment_method": {
"expiration_date": "2021-01-01T00:00:00.000Z",
"payment_key": "sbx@paymentKey"
},
"payer": {
"document": {
"nationality": "BR"
},
"first_name": "Jhon",
"last_name": "Box",
"full_name": "Box Jhon",
"email": "example@dominio.com"
},
"provider": {
"code": "ITAU",
"payer": {
"full_name": "Box Jhon",
"account": {
"type": "CC"
}
}
},
"refunds": [
{
"amount": {
"currency_code": "BRL",
"value": 1500.56
},
"status": {
"error": {
"code": "G01",
"message": "Gateway, payment method not supported"
}
}
}
]
}