Check a payment's details

Check the status, amounts, resources, and transactions related to a payment.

About payment details

When you charge or authorize an amount, the Unzer system creates a unique payment resource.

The payment resource contains all information about the payment, such as:

  • The payment’s status
  • The payment amounts and currency
  • Details of all transactions linked to the payment, such as:
  • Additional resources linked to the payment, such as:

Check a payment’s details

Unzer Insights
You can also check a payment’s details through the Unzer Insights platform.

To check a payment’s details, make a GET call to the dedicated /payments endpoint.

In the request path, add either the payment ID (paymentId) or the order ID (orderId):

GET https://api.unzer.com/v1/payments/s-pay-1

// or:

GET https://api.unzer.com/v1/payments/merchant-order-1
{

    "id": "s-pay-1",
    "state": {
        "id": 3,
        "name": "partly"
    },
    "amount": {
        "total": "100.0000",
        "charged": "50.0000",
        "canceled": "00.0000",
        "remaining": "50.0000"
    },
    "currency": "EUR",
    "orderId": "merchant-order-1",
    "resources": {
        "customerId": "",
        "paymentId": "s-pay-1",
        "basketId": "",
        "metadataId": "",
        "typeId": "s-crd-bltpvrcnqeq2"
    },
    "transactions": [
        {
            "date": "2018-09-24 18:01:02",
            "type": "authorize",
            "url": "https://api.unzer.com/v1/payments/s-pay-1/authorize/s-aut-1",
            "amount": "100.0000"
        },
        {
            "date": "2018-09-24 18:01:12",
            "type": "charge",
            "url": "https://api.unzer.com/v1/payments/s-pay-1/charges/s-chg-1",
            "amount": "50.0000"
        },
        
    ]
}
Property Type Description
id String The payment’s unique ID.
state Object The current payment status.
state.id Integer The current payment status code.
state.name String The current payment status name.
amount Object The amount details of the payment.
amount.total String The maximum amount for this order.

Initially, this is the amount that was authorized or charged.

The total amount can only be reduced if an authorization was canceled.
amount.charged String The amount transferred from the customer to you.
amount.canceled String The amount refunded from you to the customer.
amount.remaining String The difference between the total amount and the charged amount.
currency String The amount currency, in the ISO 4217 alpha-3 format.
orderId String A unique order ID that identifies the payment on your side.
resources Object Additional resources linked to the payment.
resources.customerId String The ID of the related customers resource.
resources.paymentId String The ID of the related payment resource.
resources.basketId String The ID of the related baskets resource.
resources.metadataId String The ID of the related metadata resource.
resources.typeId String The payment type ID.
transactions Object The list of all transactions related to the payment.
transactions.date String Transaction date and time.
transactions.type String Transaction type:
authorize
charge
cancel-authorize
cancel-charge
transactions.url String Transaction resource URL.
transactions.amount String Transaction amount.

Payment status codes

A payment’s status can be one of the following:

state.id Status Meaning
0 Pending An authorization was initiated, or some additional actions are required.

The customer might be redirected to a third-party payment system to enter additional data.
1 Completed The total amount and the charged amount are equal.

If you refund an overpaid amount, the status is completed as well.
2 Canceled If you cancel the entire authorization, the total amount is reduced to 0 and the status is canceled.

If all charges are refunded, the status is canceled as well.
3 Partly The total amount was charged partially.
4 Payment review The payment must be checked, to verify if the customer has overpaid.
5 Chargeback The customer requested a refund.
6 Pay page initiated A payment page has been initiated.