Pular para o conteúdo
Pagamentos

Criar link de pagamento

v1.0.0
POSThttps://api.staging.growthaisystem.com/api/v1/payment-links
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.write

Publica um link de pagamento que qualquer pessoa com a URL pode pagar, quantas vezes quiser, até ser encerrado ou expirar. Exige o header Idempotency-Key.

Corpo da requisição

application/jsonobrigatório
  • titlestringobrigatório
    • tamanho 1–120
  • descriptionstringopcional
    • tamanho máx. 2000
  • amountintegerobrigatório
    • faixa 1–100000000
  • methodsstring[]obrigatório
    • itens 1–2
  • maxInstallmentsintegeropcional
    • padrão 1
    • faixa 1–12
  • expiresAtstring (date-time)opcional
    • regex "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579]…
  • externalReferencestringopcional
    • tamanho 1–120
    • chave string
    • valor string | number | boolean | null

    Uma destas formas

    • string
      • tamanho máx. 500
    • number
    • boolean

Respostas

10 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A Idempotency-Key repetiu uma criação anterior com o mesmo corpo: devolve o MESMO link, com idempotency_replay: true.

V1PaymentLinkEscrito

  • idstring
  • titlestring
  • descriptionstring | null
  • amountinteger
  • currency"BRL"
    • sempre "BRL"
  • methodsstring[]
  • maxInstallmentsinteger
  • statusstring
    • um de"active""closed"
  • urlstring (uri)
  • expiresAtstring | null
  • externalReferencestring | null
    • chave string
    • valor string | number | boolean | null

    Uma destas formas

    • string
    • number
    • boolean
  • createdAtstring
  • idempotency_replaytruepode faltar
    • sempre true