Pular para o conteúdo principal
POST
Este endpoint permite criar uma nova assinatura para um cliente. Criar uma assinatura envolve associar um cliente a um plano de assinatura específico e registrar suas informações de pagamento.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso.

Corpo

application/json
paymentMethod
object
obrigatório
externalId
string
obrigatório

Um identificador único gerado pelo seu sistema para rastrear a transação (alfanumérico e com hífens). Recomendamos o uso do UUID4 para garantir a unicidade.

country
enum<string>
obrigatório

País do documento. ISO 3166-1 alfa-3.

Opções disponíveis:
COL,
MEX,
PER
amount
number
obrigatório

Valor da transação.

currency
enum<string>
obrigatório
Opções disponíveis:
COP,
MXN,
PEN,
USD
accountNumber
string
obrigatório

Número da conta Localpayment.

conceptCode
enum<string>
obrigatório

Motivo do pagamento (código).

Opções disponíveis:
0001,
0002,
0003,
0004,
0005,
0006,
0007,
0008,
0009,
0010,
0011,
0012,
0013,
0014,
0015,
0016,
0017,
0018,
0019,
0020,
0021,
0022,
0023,
0024,
0025,
0026,
0027,
0028,
0029,
0030,
0031,
0032,
0033,
0034,
0035,
0036,
0037,
0038,
0039,
0040
payer
object
obrigatório

Informações do pagador.

card
object
obrigatório

Dados do cartão de débito do pagador.

type
enum<string>
obrigatório

Especifica a categoria de assinatura.

Opções disponíveis:
SOFTWARE,
STREAMING,
CONTENT,
PRODUCTS,
MEMBERSHIP
autoRecurring
object
obrigatório

Propriedades da assinatura

comment
string

Informações adicionais

exchangeRateToken
string

Token fornecido pelo serviço de câmbio para utilizar uma taxa de câmbio previamente acordada.

intermediaries
array

Matriz de objetos Party. Representa outras partes na cadeia de pagamento, visto que o usuário final não é seu cliente direto. Considere a sequência da matriz: seu cliente deve ser o primeiro elemento, o cliente do seu cliente deve ser o segundo e assim por diante, até que não haja mais intermediários.

device
object
metaData
string

Objeto não estruturado para registrar quaisquer metadados que sejam significativos para você.

commercialData
object

Informações adicionais relacionadas aos bens ou serviços comercializados.

merchant
object

Informações do comerciante.

invoice
string

Referência da fatura.

item
object

Lista de itens vendidos.

shipments
object

Lista de endereços de entrega

beneficiary
object

Informações do beneficiário da conta.

retry
object

Opções de nova tentativa de Payin.

discount
object

Opções de desconto.

Resposta

OK

subscriptionId
string

Identificador único para a assinatura.

status
status · object

Status da operação.

creationDate
string

Data e hora em que a assinatura foi criada. O registro de data e hora segue o formato ISO 8601.

nextPaymentDate
string

Data e hora em que o próximo pagamento da assinatura vence. O registro de data e hora segue o formato ISO 8601.

payments
object[]

Conjunto de objetos representando os pagamentos associados à assinatura.

Última modificação em 10 de novembro de 2026