Add Customer Preferences

post

https://sandbox-api.prioritycommerce.com/v1/passport/v1/customer/{parentIdType}/{customerId}/preference

Configure default accounts and external accounts for a customer. These preferences determine which accounts are debited to settle exceptions received for that customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

parentIdType

string

enum

required

Identifier type for the parent entity. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:

customerId

string

required

The identifier value corresponding to the selected identifier type.

Body Params

Customer preference settings including default account configuration.

exceptionAccount

object

Details of preferences being set for exceptions.

refundAccount

object

Details of preferences being set for refunds.

recoveryAccount

object

Details of external account the customer has authorized to recover any exceptions that were processed from Program Manager’s account earlier.

settlementAccount

object

Details of Passport account the customer has authorized to receive external credits.

targetBalanceSweep

object

Details to enables automated fund transfers between Master and Sub-Accounts to maintain predefined target balances.

Headers

PromiseMode

string

enum

required

Required. Set to NEVER for a synchronous response or ALWAYS for asynchronous processing.

Allowed:

Responses

200

Request completed successfully as expected.

400

The request could not be accepted by the Passport server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!