Pular para o conteúdo principal

Criação de uma nova assinatura

POST 
/recurrency/subscriptions

Endpoint responsável por criar uma nova assinatura

Request​

Body

required

    customer

    object

    required

    Informações do cliente/comprador.

    name String (string)required

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[\p{L} &\d]+$

    Nome do cliente.

    email emailrequired

    Possible values: Value must match regular expression ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

    E-mail do cliente.

    documentType DocumentTypeEnum (string)required

    Possible values: [CPF, CNPJ, PASSPORT]

    document String (string)required

    Possible values: Value must match regular expression ^\d{9}$|^\d{11}$|^[A-Z0-9]{9}$

    CPF, CNPJ ou PASSAPORT do cliente.

    phone

    object

    numero de telefone.

    countryCode stringrequired

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

    areaCode stringrequired

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

    number stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    type stringrequired

    Possible values: [RESIDENTIAL, COMMERCIAL, TEMPORARY, MOBILE]

    Enum [RESIDENTIAL(Telefone Residencial.), COMMERCIAL(Telefone Comercial.), TEMPORARY(Telefone Temporário.), MOBILE(Celular)]

    credit

    object

    required

    cardNumber stringrequired

    Possible values: >= 13 characters and <= 16 characters, Value must match regular expression ^\d+$

    Número do cartão. Deve conter apenas dígitos.

    cvv stringrequired

    Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^\d+$

    Código de segurança do cartão. Deve conter apenas dígitos.

    cardholderDocument stringrequired

    Possible values: Value must match regular expression ^\d{11}$|^\d{14}$|^[A-Z0-9]{8,9}$

    Documento do titular do cartão. Pode ser CPF, CNPJ ou outro documento válido.

    cardholderName stringrequired

    Possible values: non-empty, Value must match regular expression ^[\p{L} ]+$

    Nome do titular do cartão.

    expirationMonth int32required

    Possible values: >= 1 and <= 12

    Mês de expiração do cartão. Deve estar entre 1 e 12.

    expirationYear int32required

    Ano de expiração do cartão. Os intervalos aceitos estão entre o ano atual e o ano atual + 19.

    brand stringrequired

    Bandeira do cartão.

    temporaryCardToken string

    Token único gerado pelo nosso SDK no front-end do vendedor para ser usado na transação. É útil evitar o envio de dados do cartão para o backend do vendedor. Ao utilizar este campo os dados do cartão não são necessários.

    planId stringrequired
    merchantSubscriptionId string
    chargeId uuid

Responses​

OK

Schema

    id uuid
    merchantSubscriptionId uuid
    planId uuid
    issuerTransactionId string
    nextBillingDate date-time
    failedAttempts int32
    charges uuid[]
Loading...