Skip to main content

Payment status

GET /api/payments/payment-status

Get the status of a payment

Query Parameters
  • paymentId uuid

    The unique identifier of the payment

  • uniqueReference string

    The unique reference of the payment

Header Parameters
  • api-key string required
  • api-secret string required
Responses

Payment status

Response Headers
  • x-request-id any

    Request Id for traceability

Schema
  • paymentStatus string required

    Possible values: [SUCCESS, FAILED, PENDING, NOT_FOUND, INVALID_API_KEYS, API_NOT_ENABLED]

    Status

  • paymentId uuid required

    Unique identifier for the payment

  • reference string required

    Reference for the transfer

  • uniqueReference string required

    Unique Reference for the transfer

  • amount double required

    Amount of the transfer

  • amountFee double

    Fee of the transfer

  • amountTax double

    Tax of the transfer

  • timestamp date-time

    Transfer Time

  • transferType string

    Possible values: [BANK, B2B, MOBILE_MONEY, INTERNAL, INTERNAL_FX, BILL_PAYMENT, COUNTERPARTY_TRANSFER]

    Transfer Type

  • currency string required

    Currency of the transfer

  • description string required

    Detail result of the transfer

  • globalAccountId string required

    Wallet ID

Loading...