Invoice

Financing Consumer

The Payment request and the country options

Edit "Financing Consumer" on GitHub

Financing Consumer

A FinancingConsumer payment is an invoice.

Request

1
2
3
4
POST /psp/invoice/payments 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
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
{
    "payment": {
        "operation": "FinancingConsumer",
        "intent": "<intent>",
        "currency": "NOK",
        "prices": [
            {
                "type": "Invoice",
                "amount": 1500,
                "vatAmount": 0
            }
        ],
        "description": "Test Purchase",
        "generateRecurrenceToken": "false",
        "userAgent": "Mozilla/5.0...",
        "language": "nb-NO",
        "urls": {
            "completeUrl": "https://example.com/payment-completed",
            "cancelUrl": "https://example.com/payment-cancelled",
            "callbackUrl": "https://example.com/payment-callback",
            "logoUrl": "https://example.com/logo.png",
            "termsOfServiceUrl": "https://example.com/terms.pdf"
        },
        "payeeInfo": {
            "payeeId": "5cabf558-5283-482f-b252-4d58e06f6f3b",
            "payeeReference": "PR123",
            "payeeName": "Merchant1",
            "productCategory": "PC1234",
            "subsite": "MySubsite"
        },
        "payer": {
            "payerReference": "AB1234",
        }
    },
    "invoice": {
        "invoiceType": "PayExFinancingNo"
    }
}

API requests

The options you can choose from when creating a payment with key operation set to value FinancingConsumer are listed below.

Options Before Posting A Payment

  Norway Finland Sweden
operation FinancingConsumer FinancingConsumer FinancingConsumer
currency NOK EUR SEK
invoiceType PayExFinancingNO PayExFinancingFI PayExFinancingSE
  • An invoice payment is always two-phase based -  you create an Authorize transaction that is followed by a Capture or Cancel request.