POST top-ups · Checkout API

API-ReferenzCheckout APIProfiles

POST top-ups

Checkout API Profiles

POST/api/v1/profiles/{reference}/balance/top-ups

[Coming soon] Postponement support.

Creates a new balance top-up.

• Make sure to check if top-up is allowed for the profile first.

• Make sure the top-up limits are respected.

Parameter

referencestringErforderlich

The unique token identifier or an OTP of the profile.

Request-Header

Content-Type

application/json; charset=utf-8

Authorization

Token <accessToken>

Idempotency-Key

<idempotencyKey>

Security-Token

<securityToken>

Timestamp

<timestamp>

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### POST top-ups [POST /api/v1/profiles/{reference}/balance/top-ups]

Creates a new balance top-up.
+ Make sure to check if top-up is allowed for the profile first.
+ Make sure the top-up limits are respected.

+ Parameters
    + reference (string, required) - The unique token identifier or an OTP of the profile.

+ Request (application/json; charset=utf-8)

    + Headers

            Authorization: Token <accessToken>
            Idempotency-Key: <idempotencyKey>
            Security-Token: <securityToken>
            Timestamp: <timestamp>
            
    + Attributes (object)
        + amount: 1000 (number, required) - The amount to be added to the profile's balance, expressed in the currency's minor unit.
        + currency: EUR (string, required) - The currency of the amount to be added to the profile's balance.

    + Body

            {
                "amount": 1000,
                "currency": "EUR"
            }
            
    + Schema

            {
                "type": "object",
                "properties": {
                    "amount": {
                        "type": "number"
                    },
                    "currency": {
                        "type": "string"
                    }
                }
            }
            
+ Response 200 (application/json; charset=utf-8)

    + Attributes (object)
        + oldAmount: 50 (number, required) - The old amount before making the charge request, expressed in the currency's minor unit.
        + newAmount: 1050 (number, required) - The new amount after making the charge request, expressed in the currency's minor unit.
        + currency: EUR (string, required) - The currency of the amounts.

    + Body

            {
                "oldAmount": 50,
                "newAmount": 1050,
                "currency": "EUR"
            }
            
    + Schema

            {
                "type": "object",
                "properties": {
                    "oldAmount": {
                        "type": "number"
                    },
                    "newAmount": {
                        "type": "number"
                    },
                    "currency": {
                        "type": "string"
                    }
                }
            }

Request

cURLKopieren

curl --request POST \
  'https://checkout-clients-live-eu.qnips.com/api/v1/profiles/{reference}/balance/top-ups' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'Authorization: Token <accessToken>' \
  --header 'Idempotency-Key: <idempotencyKey>' \
  --header 'Security-Token: <securityToken>' \
  --header 'Timestamp: <timestamp>' \
  --data-raw '{
    "amount": 1000,
    "currency": "EUR"
}
'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200

Response-HeaderKopieren

Content-Type: application/json; charset=utf-8

Response 200Kopieren

{
    "oldAmount": 50,
    "newAmount": 1050,
    "currency": "EUR"
}

Response-SchemaKopieren

{
    "type": "object",
    "properties": {
        "oldAmount": {
            "type": "number"
        },
        "newAmount": {
            "type": "number"
        },
        "currency": {
            "type": "string"
        }
    }
}