Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Smart Transfer

Retrieve payment

Recovers the smart transfer payment resource by its id

get/smart-transfers/payments/{id}

Path parameters

idstring uuid required

Payment primary identifier

Response

Retrieve a payment

idstring required

Payment primary identifier

preauthorizationIdstring required

Payment primary identifier

status'CONSENT_AUTHORIZED' | 'CONSENT_REJECTED' | 'PAYMENT_PENDING' | 'PAYMENT_PARTIALLY_ACCEPTED' | 'PAYMENT_SETTLEMENT_PROCESSING' | 'PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT' | 'PAYMENT_COMPLETED' | 'PAYMENT_REJECTED' | 'ERROR' | 'CANCELED' required

Lifecycle of a Smart Transfer payment. Narrower than PaymentIntentStatus: Smart Transfer payments operate under an already-authorized preauthorization, so consent-collection statuses (STARTED, ENQUEUED, CONSENT_AWAITING_AUTHORIZATION) and consent-revocation statuses (REJECTED, REVOKED, CONSUMED) do not apply.

  • CONSENT_AUTHORIZED: the payment was accepted under the preauthorization and is ready to be processed.
  • CONSENT_REJECTED: the preauthorization was rejected at execution time.
  • PAYMENT_PENDING: the payment was submitted to the institution and is awaiting confirmation.
  • PAYMENT_PARTIALLY_ACCEPTED: the payment was accepted but still needs an additional authorization.
  • PAYMENT_SETTLEMENT_PROCESSING: the settlement is being processed.
  • PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT: the funds were debited from the payer account; awaiting clearing.
  • PAYMENT_COMPLETED: the payment was confirmed by the institution.
  • PAYMENT_REJECTED: the payment was rejected after consent was authorized.
  • ERROR: an unexpected error occurred during the flow.
  • CANCELED: the payment was canceled.
amountnumber required

Payment amount

descriptionstring

Payment description

clientPaymentIdstring

Client payment identifier

createdAtstring date-time required

Date when the payment was created

updatedAtstring date-time required

Date when the payment was updated

Example response

{
  "recipient": {
    "type": "BANK_ACCOUNT",
    "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
    "name": "Conta empresa",
    "taxNumber": "12345678900",
    "paymentInstitution": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Banco J. Safra S.A.",
      "ispb": "03017677",
      "tradeName": "Banco Safra",
      "compe": "074",
      "createdAt": "2020-04-21T15:00:00.000Z",
      "updatedAt": "2020-04-21T15:00:00.000Z"
    },
    "account": {
      "branch": "0001",
      "number": "123456",
      "type": "CHECKING_ACCOUNT"
    },
    "isDefault": false,
    "pixKey": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}