Put on Account Updater Harvest Hold

post

https://api-test.qualpay.com/platform/aus/hold

Puts one card ID or all payment cards belonging to a customer ID on an Account Updater harvest hold. Held cards are not included in your Account Updater harvest.

Note: This operation is intended for merchant account use, and it requires special permissions. Contact Qualpay Support to enable it.

Body Params

AusOnHold

card_id

string

Format: Fixed length, 32 AN
Description: The card ID to be put on an Account Updater harvest hold. If both card_id and customer_id are included in the request, the system ignores customer_id and puts only the specified card_id on hold.
Conditional Requirement: Either card_id or customer_id is required.

customer_id

string

Format: Variable length, up to 32 AN
Description: Unique ID established by the merchant to identify a customer. When this field is included in the request, all card IDs belonging to this customer are put on Account Updater harvest hold. If both card_id and customer_id are included in the request, the system ignores customer_id and puts only the specified card_id on hold.
Conditional Requirement: Either card_id or customer_id is required.

merchant_id

int64

Format: Variable length, up to 16 AN
Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.
Conditional Requirement: Required if this request is on behalf of another merchant.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Request Validation Failed

500Internal Error