User Erollment

Enrolls a new customer in the payment gateway system. Creates a end-user record with associated channel configurations for payment processing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Please expand the "Examples" in the right pane to see a 200 example response payload.

HMAC-256 Signature Calculation Guide

Body Params
string
required

Reference of the end-user, ideally a UUID but supports any string.


maxLength: 50

minLength: 0

pattern: ^[a-zA-Z0-9-_.@]+$

string
required

Name of the end-user to be enrolled into the Gateway.


maxLength: 128

minLength: 0

pattern: ^[A-Z\s]+$

string
required

RFC (tax ID) of the end-user. Mandatory field, will determine uniqueness of the end-user.


maxLength: 13
minLength: 0
pattern: ^[A-ZÑ&]{4}\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])[A-Z0-9]{3}$

string

CURP of the end-user. Not mandatory field, preferably to be sent.


maxLength: 18

minLength: 0

pattern: ^$|^[A-Z]{4}[0-9]{6}[HM][A-Z]{5}[0-9A-Z][0-9]$

nullable: true

string

email of the end-user


maxLength: 256

minLength: 0

nullable: true

string

10-digit phone number of the end-user


pattern: ^$|^[0-9]{10,14}$

nullable: true

channels
object
Headers
string
required

Api Key provided to you in the onboarding process

string
required

Timestamp for the request in epoch

string
required

Unique Identifier for the Request

string
required

HMAC-256 signature for the message

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json