Payment cards
Get payment cards
Fetch details about the listed payment cards, in particular the Authorization state.
Request
[ApiBaseUrl]/api/distributor/v1/paymentCards/getAll
Property | Type | Contract | Description |
---|---|---|---|
| array of string | required | Unique identifiers of the Payment cards. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Payment cards | required | The payment cards. |
Payment card
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the payment card. |
| string Authorization state | required | Authorization state of the 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the enterprise which has access to the payment card. |
| string | required | Unique identifier of the payment card. |
| required | Information about the user's browser. |
Browser info
Property | Type | Contract | Description |
---|---|---|---|
| number | required | Integer value of the user screen width. |
| number | required | Integer value of the user screen height. |
| number | required | Integer value of the user screen color depth. |
| string | required | Value of the browser user agent. |
| string | required | Value of the browser language. |
| boolean | required | Value of the browser information on whether Java is enabled. This will always be |
| number | required | Integer value of the user timezone offset. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the payment card authorization attempt. |
| string | required | Unique identifier of the payment card being authorized. |
| string Authorization request state | required | State of the card authorization attempt. |
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