Get payment details

To get the current information about a payment, use the GET:/epayment/v1/payments/{reference} endpoint. Replace {reference} with the value you specified in your create payment request.

This will return the state of the payment at the current time.

Example request:

curl -X GET https://apitest.vipps.no/epayment/v1/payments/acme-shop-123-1234589
-H "Authorization: Bearer YOUR-ACCESS-TOKEN" \
-H "Ocp-Apim-Subscription-Key: YOUR-SUBSCRIPTION-KEY" \
-H "Merchant-Serial-Number: YOUR-MSN" \
-H "Vipps-System-Name: acme" \
-H "Vipps-System-Version: 3.1.2" \
-H "Vipps-System-Plugin-Name: acme-webshop" \
-H "Vipps-System-Plugin-Version: 4.5.6"

Example response:

{
    "aggregate": {
        "authorizedAmount": {
            "currency": "NOK",
            "value": 6000
        },
        "cancelledAmount": {
            "currency": "NOK",
            "value": 0
        },
        "capturedAmount": {
            "currency": "NOK",
            "value": 0
        },
        "refundedAmount": {
            "currency": "NOK",
            "value": 0
        }
    },
    "amount": {
        "currency": "NOK",
        "value": 6000
    },
    "state": "AUTHORIZED",
    "paymentMethod": {
        "type": "WALLET"
    },
    "profile": {},
    "pspReference": "37c34d8c-2649-448e-864b-060d5d93e4c4",
    "reference": "acme-shop-123-1234589"
}

userDetails

When scope is added to the create payment request, userDetails and sub may also be returned in the Get payment details response. The user will need to consent to sharing the profile information and then select to pay before the information will be shared.

For more details, see Profile sharing.

Special features

The special features may return extra information in the GET:/epayment/v1/payments/{reference} response. Notably:

• Express - Upon consent from the user, this will return shippingDetails and userDetails.
• Profile sharing - Upon consent from the user, this will return userDetails and sub.
• Metadata - If metadata was included in the Create payment request, it will be returned in this response.

Rate limiting

There is rate limiting applied to our APIs to increase their stability and security.

• Rate limits
• Polling guidelines