latestOpenAPI 3.1.02026-07-248556265.4 KB

cf24b926bbaa

Link de pagamento

Criar link de pagamento

post/payment_links

Parameters

#/paths/~1payins/post/parameters/0 — unresolved $ref

Request body

idstring required
status'pending' | 'waiting_payment' | 'paid' | 'expired' required
payment_methodsstring[] required
amountinteger required
namestring required
descriptionstring
linkstring
expires_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Example request

{
  "id": "string",
  "status": "pending",
  "payment_methods": [
    "pix"
  ],
  "amount": 0,
  "name": "string",
  "description": "string",
  "link": "string",
  "expires_at": "2019-08-24",
  "payment_method_details": {
    "boleto": {
      "days_until_due": 0
    },
    "credit_card": {
      "installments": 0
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Response

Successful response

idstring required
status'pending' | 'waiting_payment' | 'paid' | 'expired' required
payment_methodsstring[] required
amountinteger required
namestring required
descriptionstring
linkstring
expires_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "string",
  "status": "pending",
  "payment_methods": [
    "pix"
  ],
  "amount": 0,
  "name": "string",
  "description": "string",
  "link": "string",
  "expires_at": "2019-08-24",
  "payment_method_details": {
    "boleto": {
      "days_until_due": 0
    },
    "credit_card": {
      "installments": 0
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}