Registration

Create Customer Profile

post

This endpoint enables partner customers to create their profile. It is essential to ensure the accuracy of below:

  • User Details
  • User's Address

Failure to provide a valid customer address may result in an error during credit verification process. If you require SteadyPay to conduct an address check, please reach out to our support team for assistance.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
extUserIdstringRequired

The external user ID is a GUID associated with the profile. This is the ID used to identify partner customer in SteadyPay.

Example: debeede6-ec41-4205-a12e-daefbc773313
titlestringRequired

The title of the customer (e.g., Mr, Mrs, Ms).

Example: Mr
firstNamestringRequired

The first name of the customer.

Example: John
surnamestringRequired

The surname or last name of the customer.

Example: Smith
dobstring · date-timeRequired

The date of birth of the customer.

Example: 1973-09-14T00:00:00
phonestringRequired

The phone number of the customer.

Example: 423470140069696
emailstring · emailRequired

The email address of the customer.

Example: [email protected]
Responses
post
/api/v2/partner/customer

No content

Update Customer Profile

put

This endpoint enables partner customers to update their profile. It is essential to ensure the accuracy of below:

  • User Details
  • User's Address

Failure to provide a valid customer address may result in an error during credit verification process. If you require SteadyPay to conduct an address check, please reach out to our support team for assistance.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
titlestringRequired

The title of the customer (e.g., Mr, Mrs, Ms).

Example: Mr
firstNamestringRequired

The first name of the customer.

Example: John
surnamestringRequired

The surname or last name of the customer.

Example: Smith
dobstring · date-timeRequired

The date of birth of the customer.

Example: 1973-09-14T00:00:00
phonestringRequired

The phone number of the customer.

Example: 423470140069696
emailstring · emailRequired

The email address of the customer.

Example: [email protected]
Responses
put
/api/v2/partner/customer/updateCustomer

No content

Get Customer Details

get

This endpoint provides customer details

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
emailstringRequiredExample: 46136eed-cde2-4513-85b0-c143c8f1d144
productCodestringOptionalExample: ProductCode
Responses
200Success
application/json
get
/api/v2/partner/customer/customerDetails

Update Customer Status

put

This endpoint enables partners to notify SteadyPay about the customer status on their system. SteadyPay's customer service will perform necessary actions if required.

The endpoint allows for flexibility in specifying the status update:

  • If status is provided without products, the given status is applied universally to all products associated with the customer.
  • If the products array is populated, the status updates will be performed on each product based on the code and status provided in each array item.

This structure allows either a bulk update across all products or targeted updates for specific products.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
emailstringRequired

The email address of the customer for whom the status update is being performed.

Example: [email protected]
statusstringOptional

The status to be applied to all products for this customer, if the products array is not provided or empty. This outer status field will apply the status to each product the customer has applied or subscribed to if no specific products are listed.

Example: BLOCKED
Responses
put
/api/v2/partner/customer/updateCustomerStatus

No content

Last updated