Create an account status inquiry request.

put

https://example.com/api/v1/account-status-inquiries/{id}

This endpoint is used to create a new account status inquiry request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

A unique account status inquiry identifier.

Body Params

The account status inquiry request

reconciliationId

string

required

length between 1 and 64

An identifier that may be used to link authorization with subsequent operations for reconciliation purpose.

paymentSource

string

enum

The source of the transaction. Default value is ECommerce

Allowed:

cardDetails

Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API.

cardDetailsEncrypted

string

required

length ≥ 1

This field contains the fields from CardDetails encrypted using the JWE technique specified in the encryption guide.

webhookUrl

string | null

Webhook URL that will be called by Cards Connect to deliver notifications about the status of the transaction.

threeDSecureData

object

threeDSecureDataEncrypted

string | null

This field contains the fields from ThreeDSecureData encrypted using the JWE technique specified in the encryption guide.

Responses

201The account status inquiry request was processed.

401The user is not authorized to make this request.