Card

Card Authorization Transaction

Information about the payment’s authorization(s).

Card Authorization Transaction

The authorization resource contains information about an authorization transaction made towards a payment. To create a new authorization transaction, perform a POST towards the URL obtained from the payment.authorization.id from the payment resource below. The example is abbreviated for brevity.

GET Authorization Request

Request 



1
2
3
4



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

GET Authorization Response

Response 



1
2



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





1
2
3
4
5
6
7
8



{
    "payment": {
        "id": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
        "authorizations": {
            "id": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/authorizations"
        }
    }
}

Authorization Request

Request 



1
2
3
4



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





1
2
3
4
5
6
7
8
9
10



{
    "transaction": {
        "cardNumber": "4925000000000004",
        "cardExpiryMonth": "12",
        "cardExpiryYear": "22",
        "cardVerificationCode": "749",
        "cardholderName": "Olivia Nyhuus",
        "chosenCoBrand": "Visa"
    }
}
Field
Type
Required
transaction object check
The transaction object.
cardNumber string check
Primary Account Number (PAN) of the card, printed on the face of the card.
cardExpiryMonth integer check
Expiry month of the card, printed on the face of the card.
cardExpiryYear integer check
Expiry year of the card, printed on the face of the card.
cardVerificationCode string
Card verification code (CVC/CVV/CVC2), usually printed on the back of the card.
cardholderName string
Name of the cardholder, usually printed on the face of the card.

Authorization Response

Response 



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
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48



{
    "payment": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "authorization": {
        "id": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/authorizations/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
        "paymentToken": "5a17c24e-d459-4567-bbad-aa0f17a76119",
        "recurrenceToken": "7e6cdfc3-1276-44e9-9992-7cf4419750e1",
        "maskedPan": "123456xxxxxx1234",
        "expiryDate": "mm/yyyy",
        "panToken": "ec2a9b09-601a-42ae-8e33-a5737e1cf177",
        "cardBrand": "Visa",
        "cardType": "Credit",
        "issuingBank": "UTL MAESTRO",
        "countryCode": "999",
        "acquirerTransactionType": "3DSECURE",
        "issuerAuthorizationApprovalCode": "397136",
        "acquirerStan": "39736",
        "acquirerTerminalId": "39",
        "acquirerTransactionTime": "2017-08-29T13:42:18Z",
        "authenticationStatus": "Y",
        "nonPaymentToken": "",
        "externalNonPaymentToken": "",
        "transaction": {
            "id": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
            "created": "2016-09-14T01:01:01.01Z",
            "updated": "2016-09-14T01:01:01.03Z",
            "type": "Authorization",
            "state": "Initialized",
            "number": 1234567890,
            "amount": 1000,
            "vatAmount": 250,
            "description": "Test transaction",
            "payeeReference": "AH123456",
            "failedReason": "ExternalResponseError",
            "failedActivityName": "Authorize",
            "failedErrorCode": "REJECTED_BY_ACQUIRER",
            "failedErrorDescription": "General decline, response-code: 05",
            "isOperational": "TRUE",
            "activities": { "id": "/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/ec2a9b09-601a-42ae-8e33-a5737e1cf177/activities" },
            "operations": [
                {
                    "href": "https://api.payex.com/psp/creditcard/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
                    "rel": "edit-authorization",
                    "method": "PATCH"
                }
            ]
        }
    }
}
Field
Type
payment object
The payment object.
authorization object
The authorization object.
direct string
The type of the authorization.
cardBrand string
Visa, MC, etc. The brand of the card.
cardType string
Credit Card or Debit Card. Indicates the type of card used for the authorization.
issuingBank string
The name of the bank that issued the card used for the authorization.
paymentToken string
The payment token created for the card used in the authorization.
maskedPan string
The masked PAN number of the card.
expiryDate string
The month and year of when the card expires.
panToken string
The token representing the specific PAN of the card.
panEnrolled string
acquirerTransactionTime string
The ISO-8601 date and time of the acquirer transaction.
id string
The relative URL and unique identifier of the `itemDescriptions` resource . Please read about [URL Usage](/checkout-v3/get-started/fundamental-principles#url-usage) to understand how this and other URLs should be used in your solution.
nonPaymentToken string
The result of our own card tokenization. Activated in POS for the merchant or merchant group.
externalNonPaymentToken string
The result of an external tokenization. This value will vary depending on card types, acquirers, customers, etc. For Mass Transit merchants, transactions redeemed by Visa will be populated with PAR. For Mastercard and Amex, it will be our own token.
transaction object
The object representation of the generic transaction resource, containing information about the current transaction.
id string
The relative URL and unique identifier of the `transaction` resource . Please read about [URL Usage](/checkout-v3/get-started/fundamental-principles#url-usage) to understand how this and other URLs should be used in your solution.
created string
The ISO-8601 date and time of when the transaction was created.
updated string
The ISO-8601 date and time of when the transaction was updated.
type string
Indicates the transaction type.
state string
Initialized, Completed or Failed. Indicates the state of the transaction.
number integer
The transaction `number`, useful when there's need to reference the transaction in human communication. Not usable for programmatic identification of the transaction, where `id` should be used instead.
amount integer
Amount is entered in the lowest monetary unit of the selected currency. E.g. 10000 = 100.00 NOK, 5000 = 50.00 SEK.
vatAmount integer
If the amount given includes VAT, this may be displayed for the user on the payment page (redirect only). Set to 0 (zero) if this is not relevant.
description string
A textual [description](/old-implementations/payment-instruments-v1/card/technical-reference/description) of the purchase. Maximum length is 40 characters.
payeeReference string(30)
A unique reference from the merchant system. Set per operation to ensure an exactly-once delivery of a transactional operation. Length and content validation depends on whether the `transaction.number` or the `payeeReference` is sent to the acquirer. **If Swedbank Pay handles the** **settlement**, the `transaction.number` is sent to the acquirer and the `payeeReference` must be in the format of `A-Za-z0-9` and `string(50)`. **If you handle the settlement**, Swedbank Pay will send the `payeeReference` and it will be limited to the format of `string(12)`. All characters **must be digits**.
failedReason string
The human readable explanation of why the payment failed.
isOperational bool
true if the transaction is operational; otherwise false.
operations array
The array of operations that are possible to perform on the transaction in its current state.