Read a Payment Transaction

To check the status, or other details, you need to read the Payment Transaction:

Request

GET /api/v2/Payment/Transactions/PCI_AEVDQO42JC3YHO4PSAZ3CQJU4S0P5A HTTP/1.1
Host: connect-testing.secupay-ag.de
Authorization: Bearer qb56tjj1bcvo9n2nj4u38k84lo
Accept: application/json

If everything is fine, the API responds with 200 OK and the object representation of the Payment Transaction:

Response

HTTP/1.1 200 OK
Content-Type: application/json
...
 
{
    "object": "payment.transactions",
    "id": "PCI_AEVDQO42JC3YHO4PSAZ3CQJU4S0P5A",
    // ...
    "trans_id": 35412359,
    // ...
    "product": "Vorkasse",
    // ...
    "amount": 5000,
    "currency": "EUR",
    "created": "2021-06-09T22:09:09+02:00",
    "updated": "2021-06-09T22:09:09+02:00",
    // ...
    "status": 25,
    "status_text": "Vorkasse wartend",
    "details": {
        "cleared": "open",
        "status": 25,
        "status_text": "Vorkasse wartend",
        "status_simple": 2,
        "status_simple_text": "authorized",
        "amount": 5000,
        "description": "",
        "description_raw": ""
    }
    // ...
}

This signalizes a payment of €50.00.

A refunded or reversed PayPal payment differs from that in the negative amount, the payment product type, and a reference to the original transaction:

Payment Transaction

{
    "object": "payment.transactions",
    "id": "PCI_WMC2TN4PT66CY90TS8YZY34QK9W2N7",
    // ...
    "parents": [
        {
            "object": "payment.transactions",
            "id": "PCI_AEVDQO42JC3YHO4PSAZ3CQJU4S0P5A",
            "ref_type_id": 19,
            "trans_id": 35448445
        }
    ],
    // ...
    "product": "Erstattung",
    // ...
    "amount": -1000,
    "currency": "EUR",
    "created": "2021-07-05T13:32:50+02:00",
    "updated": "2021-07-05T13:33:24+02:00",
    "description": "TA-Code 35412359 (09.06.21)|Refund TA-Code 35448447",
    // ...
    "status": 6,
    "status_text": "abgeschlossen",
    "details": {
        "cleared": "open",
        "status": 6,
        "status_text": "abgeschlossen",
        "status_simple": 1,
        "status_simple_text": "accepted",
        // ...
    }, 
    // ...
}

This signalizes a refund of €10.00 for the former incoming payment.

An explanation of the fields:

Field	Type	Meaning
`object`	`string`	Always `"payment.transactions"`
`id`	`string`	Object ID
`parents`	`array`	Optional. Array of linked transactions, for instance the original Payment Transaction that has been refunded or reversed.
`parents/{n}/object`	`string`	Always `"payment.transactions"`
`parents/{n}/id`	`string`	Object ID of the referenced Payment Transaction
`parents/{n}/ref_type_id`	`int`	Reference type `19` to reference the refunded or reversed Payment Transaction
`parents/{n}/trans_id`	`int`	Transaction ID of the referenced Payment Transaction
`product`	`string`	Product name
`amount`	`int`	Monetary amount in the smallest currency unit. Negative if it is payed back (transaction for a refund or reversal).
`currency`	`string`	ISO 4217 currency code such as `EUR`, `CHF`, `GBP` or `USD`.
`description`	`string`	Description
`status`	`int`	Status ID
`status_text`	`string`	Status name
`details/status`	`int`	Same as `status`
`details/status_text`	`string`	Same as `status_text`
`details/status_simple`	`int`	Simple status ID
`details/status_simple_text`	`string`	Simple status text

When it comes to the status, we recommend:

to use the "simple status" (details/status_simple) for program decisions;
to display the normal status text (status_text) to the user.

These are the "simple statuses":

ID	Text	Meaning
0	`"proceed"`	Initial status of every transaction. The payment is not authorised, nor wanted to capture.
1	`"accepted"`	The request for capture or for invoice payment was accepted. You can deliver now. (When you use invoice payment, you need to add the partial deliveries, and to request the capture along with your final delivery.)
2	`"authorized"`	The payment is authorised, but was not requested to capture yet.
3	`"denied"`	The payment was rejected for some reason.
4	`"issue"`	A problem occurred after the payment was accepted. For instance, the payer wanted a credit card charge back.
5	`"void"`	The payment was cancelled, or refunded.
6	`"issue_resolved"`	The problem is resolved. For instance, the charge back could be objected.
7	`"refund"`	The payment is flagged for refund. It will be processed with our next bank cycle.
8	`"created"`
9	`"paid"`	We have received the invoice payment.
10	`"pending"`	The payment was requested to capture, but you must wait with delivery for status `accepted`. This status is always set when we wait for the advance payment. It is also used with other payment methods to perform an additional risk check.
11	`"subscription approved"`	The transaction used to authorise further payments has been approved.
12	`"subscription declined"`	The transaction used to authorise further payments has been declined.
13	`"on hold"`
14	`"waiting for shipment"`