Docs
PTENES Website Sign up

TransfersCreate Transfer

Create Transfer

POST/v1/transferhttps://api.securitypag.com

Authentication: Bearer · payout key

To create a transfer, use the route v1/transfer. This route supports PIX transfers.

Important: Instead of using the default token to perform the request, you must use the API Withdrawal Credential, available on the Integrations, page, in the card "API Withdrawal Credentials".

Request body

Sent as JSON.

  • amountintegerrequired

    Transfer amount in cents. Example: R$ 1,00.

  • methodstringrequired

    Transfer method. Currently supported: PIX.

  • externalRefstring

    External reference assigned by the integrator.

  • notificationUrlstring

    URL where transfer webhooks will be sent.

  • pixobjectrequired2 fields

    Pix transfer data.

    • pixKeystringrequired

      Recipient Pix key.

    • pixKeyTypestringrequired

      Pix key type (CPF, CNPJ, EMAIL, PHONE, EVP, COPYPASTE).

Responses

200Response object returned when the transfer is successfully created or updated.
  • idstring

    Unique identifier of the transfer.

  • amountinteger

    Transfer amount in cents.

  • methodstring

    Transfer method used (e.g. PIX).

  • currencystring

    Transfer currency code (e.g. BRL).

  • statusstring

    Current transfer status (IN_QUEUE, IN_ANALYSIS, APPROVED, PROCESSING, COMPLETED, REFUSED, FAILED).

  • messagestring

    Additional message related to the transfer status.

  • externalRefstring

    External reference assigned by the integrator.

  • notificationUrlstring

    URL configured to receive transfer notifications.

  • approvedAtstring

    Date and time when the transfer was approved.

  • refusedAtstring

    Date and time when the transfer was refused.

  • cancelledAtstring

    Date and time when the transfer was cancelled.

  • paidAtstring

    Date and time when the transfer was paid.

  • createdAtstring

    Transfer creation date and time.

  • updatedAtstring

    Last transfer update date and time.

  • dataobject4 fields

    Transfer method–specific data.

    • methodstring

      Transfer method related to the returned data.

    • pixKeystring

      Pix key used in the transfer when method is PIX.

    • e2estring

      Pix End to End ID when method is PIX.

    • pixKeyTypestring

      Pix key type (CPF, CNPJ, EMAIL, PHONE, EVP).

400Validation error when creating the transfer.

Something wrong on this page? Talk to us