v2

latestOpenAPI 3.1.02026-07-264249163.7 KB
Customer

Preapprove amount by customer

Verify tokenized customer will be approved for the amount of the order prior to order creation. This API does not authorize the amount nor does it hold the amount for a future order. Also, you are not required to use this API before creating a customer order. An example use-case is to verify approval status ahead of subscription payment due date, and to contact the customer in advance to avoid failed payment.

post/v2/customer/{customer_uuid}/preapprove

Path parameters

customer_uuidstring required

The Customer UUID to preapprove

Request body

amount_in_centsinteger required

The amount in cents

currencystring required

The 3 character currency code as defined by ISO 4217

Response

Successful Operation

uuidstring

The unique identifier for this response

approvedboolean

Whether the shopper is pre-approved for the given amount