CollectPayersPayers

Create Payer Profile

Creates a new payer profile outside of a transaction. This operation is useful for setting up a payer's information in advance, allowing for smoother transaction processing in the future. The profile includes essential details such as the payer's name, email, and mobile number.

Request

This endpoint expects an object.
payerIdstringOptionalformat: "uuid"

Persistent identifier for the payer. See the Payer ID guide.

namestringOptional
Full name of the payer.
emailAddressstringOptionalformat: "email"
Email address of the payer.
mobileNumberstringOptional
Mobile number of the payer.
metadatamap from strings to stringsOptional
Additional metadata for the payer.

Response

Payer profile created successfully.
payerIdstringOptionalformat: "uuid"

Persistent identifier for the payer. See the Payer ID guide.

namestringOptional
Full name of the payer.
emailAddressstringOptionalformat: "email"
Email address of the payer.
mobileNumberstringOptional
Mobile number of the payer.
metadatamap from strings to stringsOptional
Additional metadata for the payer.

Errors

400
Bad Request Error