Operations

Operation paid-payment

The paid-payment operation confirms that the transaction has been successful and that the payment is completed.

A paid-payment operation looks like this:

`paid-payment` operation

Copy json to clipboard

1
2
3
4
5
6

{
   "href": "https://api.externalintegration.payex.com/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/paid",
   "rel": "paid-payment",
   "method": "GET",
   "contentType": "application/json"
}

To inspect the paid payment, you need to perform an HTTP GET request towards the operation’s href field. An example of the request and response is given below.

Request

1
2
3
4

GET /psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/paid HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

Response

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
    "payment": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "paid": {
        "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/paid",
        "number": 1234567890,
        "transaction": {
            "id": "/pspinvoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/",
            "number": 1234567891
        },
        "payeeReference": "CD123",
        "orderReference": "AB1234",
        "amount": 1500
    }
}

Operation failed-payment

The failed-payment operation means that something went wrong during the payment process. The transaction was not authorized, and no further transactions can be created if the payment is in this state.

A failed-payment operation looks like this:

`failed-payment` operation

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6

{
   "href": "https://api.externalintegration.payex.com/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/failed",
   "rel": "failed-payment",
   "method": "GET",
   "contentType": "application/problem+json"
}

To inspect why the payment failed, you need to perform an HTTP GET request towards the operation’s href field.

The problem message can be found in details field. Under problems you can see which problem occurred, a description of the problem and the corresponding error code.

An example of the request and response is given below.

Response

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
    "problem": {
        "type": "https://api.externalintegration.payex.com/psp/errordetail/invoice/acquirererror",
        "title": "Operation failed",
        "status": 403,
        "detail":  "Unable to complete Authorization transaction, look at problem node!", 
        "problems": [
            {
                "name": "ExternalResponse",
                "description": "REJECTED_BY_ACQUIRER-unknown error, response-code: 51"
            }
        ]
    }
}

Operation aborted-payment

The aborted-payment operation means that the merchant aborted the payment before the payer fulfilled the payment process. You can see this under abortReason in the response.

An aborted-payment operation looks like this:

`aborted-payment` operation

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6

{
    "href": "https://api.externalintegration.payex.com/psp/creditcard/payments/<paymentId>/aborted",
    "rel": "aborted-payment",
    "method": "GET",
    "contentType": "application/json"
}

To inspect why the payment was aborted, you need to perform an HTTP GET request towards the operation’s href field. An example of the request and response is given below.

Request

1
2
3
4

GET /psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/aborted HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json

Response

Copy json to clipboard

1
2

HTTP/1.1 200 OK
Content-Type: application/json

1
2
3
4
5
6

{
    "payment": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "aborted": {
        "abortReason": "Aborted by consumer"
    }
}