Bavindo
  1. Payment
Bavindo
API
  • API
  • Webhook
  • v1
    • Terminal
      • POS Connected Terminals
    • Payment
      • POS Payment Create
        POST
      • POS Payment Cancel
        POST
      • Get Payment Details
        GET
      • POS Payment Refund Referenced
        POST
    • NFC
      • NFC Transaction Start/Continue
      • NFC Transaction Stop
  1. Payment

Get Payment Details

Developing
GET
https://api.bavindo.com/v1/payment/{payment_id}
INFO
This endpoint can be accessed with the following API type: pos-payment,
TIP
Don't have an API key? Create one in your Customer Area with the type pos-payment, go to Developers -> Api Credentials,
INFO
When retrieving a payment, the API key needs to have the same store ID a the payment itself.

Getting the details of a payment#

When you make a payment, a communication or technical issue can prevent your POS app from receiving a response. Without this response it is unclear to your staff if the transaction has been processed. They may try to cancel or refund the payment, or repeat the payment.
Instead, your integration should request the payment's status to verify whether the payment is:
Processed
In progress
Not found
This can be done by reading the status of the payment. The hyperlinks explain in detail how to check the adyen_response.

When should you check the payment status#

We recommend that your integration automatically checks the status of a transaction any time it fails to receive a payment response.
Payment requests time out after a while. If you do not receive a payment response (or you receive a response indicating a time-out) after 150 seconds, and the internet connection hasn't dropped, your integration should automatically check the transaction status.
The normal status of the payment should suffice, if you want more information please check the adyen_response.
The adyen_response will only be filled in a timeframe of 48 hours since the start of the original payment. If it's not filled null will be set.

Response status#

inprogress The payment is started and ongoing.
success The payment has been successfully paid.
failure The payment has failed.

Response parmeter info#

Please refer to the Responses for a per item description.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
payment_id
string 
required

Responses

🟢200Success
application/json
Body
payment_id
string 
required
The ID of the Payment
store_id
string 
required
The Store ID associated with the Payment and API Key
terminal_id
string 
required
The ID of the pysical Adyen terminal
pos_id
string 
required
The ID of your POS unit
date
string 
required
The start of the payment in a datetime (ISO 8601)
Example:
2024-07-31T11:19:23Z
updated_date
string 
required
The last update of the payment in a datetime (ISO 8601)
Example:
2024-07-31T11:20:23Z
payment_amount
object 
required
currency
string 
required
The currency if the payment (ISO 4217)
Example:
EUR
amount
integer 
required
The amount of the goods (cents)
Example:
1000
amount_tip
integer 
required
The tip amount when given (cents)
Example:
50
amount_total
integer 
required
Amount + Tip = Total (cents)
Example:
1050
amount_refunded
integer 
required
Amount refunded (cents)
Example:
0
status
string 
required
The current status of the payment
payment_method
string 
required
The payment method of the payment
Example:
iip
synchronous_method
string  | null 
required
The synchronous method of the payment if it applies
Examples:
asyncsync
metadata
object  | null 
required
The metadata provided with with creation of the payment
your_info
string 
required
adyen_response
object  | null 
required
The response of the verify transaction from Adyen (Only works in a 48 hour time frame of the payment)
SaleToPOIResponse
object 
required
logs
array[string]
required
The logs of the payment ASC
environment
string 
required
The environment the API key is working on
Examples:
testlive
Example
{
    "payment_id": "33bcb700-df93-4d6f-bde6-75daad0e",
    "store_id": "3294V22322755KZ6TWHGPRJ",
    "terminal_id": "P400Plus-000000000",
    "pos_id": "willekeurig",
    "date": "2024-11-26T10:50:53Z",
    "updated_date": "2024-11-26T10:53:30Z",
    "payment_amount": {
        "currency": "EUR",
        "amount": 1000,
        "amount_tip": 50,
        "amount_total": 1050,
        "amount_refunded": 0
    },
    "status": "success",
    "payment_method": "ipp",
    "synchronous_method": "async",
    "metadata": {
        "your_info": "123456789"
    },
    "adyen_response": {
        "SaleToPOIResponse": {
            "MessageHeader": {
                "MessageCategory": "TransactionStatus",
                "MessageClass": "Service",
                "MessageType": "Response",
                "POIID": "P400Plus-000000000",
                "ProtocolVersion": "3.0",
                "SaleID": "willekeurig",
                "ServiceID": "503aac7f"
            },
            "TransactionStatusResponse": {
                "MessageReference": {
                    "MessageCategory": "Payment",
                    "SaleID": "willekeurig",
                    "ServiceID": "dbbbe1f2"
                },
                "RepeatedMessageResponse": {
                    "MessageHeader": {
                        "MessageCategory": "Payment",
                        "MessageClass": "Service",
                        "MessageType": "Response",
                        "POIID": "P400Plus-000000000",
                        "ProtocolVersion": "3.0",
                        "SaleID": "willekeurig",
                        "ServiceID": "dbbbe1f2"
                    },
                    "RepeatedResponseMessageBody": {
                        "PaymentResponse": {
                            "POIData": {
                                "POIReconciliationID": "1000",
                                "POITransactionID": {
                                    "TimeStamp": "2024-11-26T10:50:53.000Z",
                                    "TransactionID": "bMF5001732618253001.JJVJJ2GT2FJJXQ65"
                                }
                            },
                            "PaymentReceipt": [
                                {
                                    "DocumentQualifier": "CashierReceipt",
                                    "OutputContent": {
                                        "OutputFormat": "Text",
                                        "OutputText": [
                                            {
                                                "CharacterStyle": "Bold",
                                                "EndOfLineFlag": true,
                                                "Text": "key=header1"
                                            },
                                            {
                                                "CharacterStyle": "Bold",
                                                "EndOfLineFlag": true,
                                                "Text": "key=header2"
                                            },
                                            {
                                                "CharacterStyle": "Bold",
                                                "EndOfLineFlag": true,
                                                "Text": "name=KOPIE%20WINKELIER&key=merchantTitle"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "key=filler"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "name=Datum&value=26%2f11%2f2024&key=txdate"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "name=Tijd&value=11%3a50%3a53&key=txtime"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "key=filler"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "name=Kaart&value=%2a%2a%2a%2a9999&key=pan"
                                            },
                                            {
                                                "EndOfLineFlag": true,
                                                "Text": "name=PAN%20seq.&value=33&key=panSeq"
                                            },
🟠404Payment Not Found
Modified at 2024-11-19 11:47:19
Previous
POS Payment Cancel
Next
POS Payment Refund Referenced
Built with