Skip to main content
POST
Create payment method

Authorizations

client_id
string
header
required
secret_key
string
header
required

Body

application/json
providerId
string<uuid>
required

Provider that operates the payment method.

customerId
string<uuid>
required

Customer the payment method belongs to.

type
enum<string>
required

The kind of payment method.

Available options:
CREDIT_CARD,
PIC_PAY
config
object

Provider-specific configuration for the payment method, such as tokens, card brand or wallet identifiers. Defaults to an empty object.

Response

201 - application/json

Default Response

id
string<uuid>
required

Unique payment method identifier.

providerId
string<uuid>
required

Provider that operates the payment method.

customerId
string<uuid>
required

Customer the payment method belongs to.

status
enum<string>
required

Current lifecycle state. A DELETED method cannot back new payments.

Available options:
ACTIVE,
DELETED
type
enum<string>
required

The kind of payment method.

Available options:
CREDIT_CARD,
PIC_PAY
config
object
required

Provider-specific configuration for the payment method.

createdAt
string<date-time>
required

When the payment method was created.

updatedAt
string<date-time>
required

When the payment method was last updated.