Skip to main content

Creating charges

POST 
/paymentlink/create

This endpoint allows the creation of a new charge via API, using the payment link model.

Request​

Header Parameters

    Authorization stringrequired

    Authentication Token.

    Example: Bearer <token>

Body

required

    charge

    object

    required

    name stringnullable

    Charge name.

    description stringnullable

    Charge description.

    order_number stringnullable

    Possible values: <= 15 characters

    Payment order identifier.

    redirect_url string

    Possible values: <= 1000 characters

    URL redirect.

    payment

    required

    methods string[]required

    Payment methods that will be included in the charge.

    brcode_arrangements string[]

    Mandatory if the value 'BRCODE' is passed in the payment_methods field.

    amounts

    object

    Billing amounts. The sum cannot exceed 999999999 (R$9,999,999.99)

    product integer

    Value of the product of the charge. Value only in cents e.g. R$100 is equivalent to R$1.0

    delivery integer

    Shipping cost of collection. Value only in cents e.g. R$100 is equivalent to R$1.0

    options

    object

    required

    Billing options.

    allow_create_pix_key boolean

    Field used to inform whether the requester authorizes create a pix key for the user, if one does not exist.

    card_max_installment_number number

    Field used to inform the maximum number of installments for a charge. This field is mandatory when 'payment_methods' contains the value 'CREDIT_CARD'.

    expired_at string

    Field used to inform the charge expiration date.

Responses​

Charge created.

Schema

    brcode stringrequired

    Qrcode generated for payment.

    name stringrequired

    Charge name.

    description stringrequired

    Charge description.

    amount integerrequired

    Charge amount in cents.

    link stringrequired

    Charge link.

    deeplink stringrequired

    Charge deeplink.

    pixKey stringrequired

    Pix key.

    txid stringrequired

    Transaction code txid.

    paymentMethods string[]required

    Payments method.

    paymentBrcodeArrangements string[]required

    Payment Methods.

    status stringrequired

    Current billing status.

    chargeName stringrequired

    Charge name.

    expirationDate stringrequired

    Expirate date.

    ppMaxInstallmentNumber numberrequired

    maximum number of installments.

    cardMaxInstallmentNumber numberrequired

    maximum number of installments.

    maxPaymentQuantity numberrequired

    Maximum amount of payments accepted.

    details

    required

    productAmount integer

    Product value in cents.

    deliveryAmount integer

    Shipping cost in cents.

    orderNumber stringnullable

    Order number.

    redirectURL stringnullable

    URL redirect

Loading...