Payment cards

Get payment cards

Fetch details about the listed payment cards, in particular the Authorization state.

Request

[ApiBaseUrl]/api/distributor/v1/paymentCards/getAll

{
    "Client": "My Client 1.0.0",
    "PaymentCardIds": [
        "dc2f8608-9d71-47fd-9d41-ad1a009913c6"
    ]
}

Response

{
    "PaymentCards": [
        {
            "Id": "dc2f8608-9d71-47fd-9d41-ad1a009913c6",
            "AuthorizationState": "Authorizable"
        }
    ]
}

Payment card

Authorization state

  • Authorized - Finite state. The payment card has been authorized.

  • Authorizable - Non-finite state. The payment card can be authorized.

  • Unauthorizable - Finite state. The payment card cannot be authorized.

Authorize payment card

Request authorization of the specified payment card.

Request

[ApiBaseUrl]/api/distributor/v1/paymentCards/authorize

{
    "Client": "My Client 1.0.0",
    "EnterpriseId": "8a51f050-8467-4e92-84d5-abc800c810b8",
    "PaymentCardId": "dc2f8608-9d71-47fd-9d41-ad1a009913c6",
    "BrowserInfo": {
        "ScreenWidth": 2560,
        "ScreenHeight": 1440,
        "ColorDepth": 24,
        "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.85 Safari/537.36",
        "Language": "cs",
        "JavaEnabled": false,
        "TimeZoneOffset": -120
    }
}

Browser info

Response

{
    "Id": "94835eb5-24e1-421f-9915-ad1a009de562",
    "PaymentCardId": "dc2f8608-9d71-47fd-9d41-ad1a009913c6",
    "State": "Authorized"
}

Authorization request state

  • Authorized - Finite state. The payment card authorization has been successfully completed.

  • Requested - Non-finite state. The payment card authorization is requested from the user.

  • Pending - Non-finite state. The payment card authorization is waiting to be requested from the user.

  • Declined - Finite state. The payment card authorization has been declined.

  • Canceled - Finite state. The payment card authorization has been canceled.

Last updated