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.

payerIdstringOptional

Unique identifier for the payer.

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.

payerIdstring

Unique identifier for the payer.

namestring

Full name of the payer.

emailAddressstringformat: "email"

Email address of the payer.

mobileNumberstring

Mobile number of the payer.

metadatamap from strings to strings

Additional metadata for the payer.

Errors

400

Bad Request Error

$	curl -X POST https://api.payos.money/v1/payers \
>	-H "Content-Type: application/json" \
>	-d '{
>	"payerId": "PAYER_abcdef123456",
>	"name": "Jane Doe",
>	"emailAddress": "jane.doe@example.com",
>	"mobileNumber": "+15559876",
>	"metadata": {
>	"payerId": "PAYER_abcdef123456"
>	}
>	}'

1	{
2	"payerId": "PAYER_abcdef123456",
3	"name": "Jane Doe",
4	"emailAddress": "jane.doe@example.com",
5	"mobileNumber": "+15559876",
6	"metadata": {
7	"additionalInfo": "Sample metadata"
8	}
9	}

$	curl -X POST https://api.payos.money/v1/payers \
>	-H "Content-Type: application/json" \
>	-d '{
>	"payerId": "PAYER_abcdef123456",
>	"name": "Jane Doe",
>	"emailAddress": "jane.doe@example.com",
>	"mobileNumber": "+15559876",
>	"metadata": {
>	"payerId": "PAYER_abcdef123456"
>	}
>	}'

1	{
2	"payerId": "PAYER_abcdef123456",
3	"name": "Jane Doe",
4	"emailAddress": "jane.doe@example.com",
5	"mobileNumber": "+15559876",
6	"metadata": {
7	"additionalInfo": "Sample metadata"
8	}
9	}