Create a new consumer

post

https://api.gratifypay.com/bnpl/2.0/consumers

Creates a new consumer entity in the Gratify system or partner environment. The consumer entity is required to have a valid email address and mobile phone number and provide a supported ecommerce method for payment - either a credit card or an ACH bank account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Valid email address of the consumer.

firstName

string

First name of the consumer.

lastName

string

Last name of the consumer.

accountStatus

string

enum

Status of the consumer's account.

Allowed:

riskStatus

string

enum

Risk level associated with the consumer.

Allowed:

accountRole

string

enum

required

Role of the consumer's account.

Allowed:

partnerReferenceId

string

Optional data provided by the partner API client as an index or link back to the client-side equivalent model. Stored with the Gratify Consumer.

partnerCustomData

string

Optional custom XML, JSON, or similar data provided and managed by the partner API client. Stored with the Gratify Consumer.

Responses

Language

Credentials

Basic

base64

Loading…

Response

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

application/json

201Consumer successfully created

400The request is malformed or input is not valid. Double check your request message body is to specification and try again.

401Unuahtorized access to the Gratify API. Double check your API credentials and try again.

404The specified resource was not found. Double check your URL and version strings try again.

5XXAn unexpected error occurred at the Gratify Server