Skip to main content

Bulk Payment status

GET /api/payments/bulk-payment-status

Get the status of a Bulk payment with Batch ID

Query Parameters
  • batch-id uuid required

    The unique batch identifier of the payment

Header Parameters
  • api-key string required

    API key for authentication

  • api-secret string required

    API secret for authentication

  • page-size int32

    Default value: 10

    Size of the page to be returned

  • page-number int32

    Default value: 1

    Page number to be returned

Responses

Bulk Payment status

Response Headers
  • x-request-id any

    Request Id for traceability

Schema
  • Array [
  • 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...