Invoice

Invoice Authorization Transaction

schedule 4 min read

Information about the payment’s authorization(s).

Edit "Invoice Authorization Transaction" on GitHub

Create Authorization Transaction

The redirect-authorization operation redirects the payer to Swedbank Pay Payments where the payment is authorized.

Request

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

{
    "transaction": {
        "activity": "FinancingConsumer"
    },
    "consumer": {
        "socialSecurityNumber": "26026708248",
        "customerNumber": "123456",
        "email": "olivia.nyhuus@payex.com",
        "msisdn": "+4798765432",
        "ip": "127.0.0.1"
    },
    "legalAddress": {
        "addressee": "Olivia Nyhuus",
        "streetAddress": "SaltnesToppen 43",
        "zipCode": "1642",
        "city": "Saltnes",
        "countryCode": "no"
    },
    "billingAddress": {
        "addressee": "Olivia Nyhuus",
        "streetAddress": "SaltnesToppen 43",
        "zipCode": "1642",
        "city": "Saltnes",
        "countryCode": "no"
    }
}
Required Field Type Description
check transaction object The transaction object.
  └➔ activity string Only the value "FinancingConsumer" or "AccountsReceivableConsumer"
  consumer object The payer object.
  └➔ socialSecurityNumber string The social security number of the payer.
  └➔ customerNumber string Customer number of the payer.
  └➔ email string The customer email address.
  └➔ msisdn string The MSISDN of the payer.
  └➔ ip string The IP address of the payer.
  legalAddress object The Address object.
  └➔ addressee string The full name of the addressee of this invoice
  └➔ coAddress string The co Address of the addressee.
  └➔ streetAddress string The street address of the addresse. Maximum 50 characters long.
  └➔ zipCode string The zip code of the addresse.
  └➔ city string The city name of the addresse.
  └➔ countryCode string The country code of the addresse.
  billingAddress object The BillingAddress object for the billing address of the addresse.
  └➔ addressee string The full name of the billing address adressee.
  └➔ coAddress string The co address of the billing address adressee.
  └➔ streetAddress string The street address of the billing address adressee. Maximum 50 characters long.
  └➔ zipCode string The zip code of the billing address adressee.
  └➔ city string The city name of the billing address adressee.
  └➔ countryCode string The country code of the billing address adressee.

Response

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
{
    "payment": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
    "authorization": {
        "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/authorizations/ec2a9b09-601a-42ae-8e33-a5737e1cf177",
        "consumer": {
            "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/consumer"
        },
        "legalAddress": {
            "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/legaladdress"
        },
        "billingAddress": {
            "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/billingaddress"
        },
        "transaction": {
            "id": "/psp/invoice/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": "Failed",
            "number": 1234567890,
            "amount": 1000,
            "vatAmount": 250,
            "description": "Test transaction",
            "payeeReference": "AH123456",
            "failedReason": "ExternalResponseError",
            "failedActivityName": "Authorize",
            "failedErrorCode": "ThirdPartyErrorCode",
            "failedErrorDescription": "ThirdPartyErrorMessage",
            "isOperational": "TRUE",
            "activities": {
                "id": "/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1/transactions/ec2a9b09-601a-42ae-8e33-a5737e1cf177/activities"
            },
            "operations": [
                {
                    "href": "https://api.externalintegration.payex.com/psp/invoice/payments/7e6cdfc3-1276-44e9-9992-7cf4419750e1",
                    "rel": "edit-authorization",
                    "method": "PATCH"
                }
            ]
        }
    }
}
Field Type Description
payment string The relative URL and unique identifier of the payment resource this authorization belongs to. Please read about URL Usage to understand how this and other URLs should be used in your solution.
authorization object The transaction object.
└➔ id string The relative URL and unique identifier of the authorization resource this authorization belongs to. Please read about 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 string The transaction number, useful when there’s need to reference the transaction in human communication. Not usable for programmatic identification of the transaction, for that id should be used instead.
└➔ amount integer The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK.
└➔ vatAmount integer The payment’s VAT (Value Added Tax) amount, entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK. The vatAmount entered will not affect the amount shown on the payment page, which only shows the total amount. This field is used to specify how much of the total amount the VAT will be. Set to 0 (zero) if there is no VAT amount charged.
└➔ description string A 40 character length textual description of the purchase.
└➔ payeeReference string A unique reference from the merchant system. It is set per operation to ensure an exactly-once delivery of a transactional operation. See payeeReference for details. In Invoice Payments payeeReference is used as an invoice/receipt number, if the receiptReference is not defined.
└➔ 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.

The authorization resource contains information about an authorization transaction made towards a payment, as previously described.