Skip to main content

Get a charge batch by ID

GET 
/api/gateway/v1/user-billing/charge-batches/:id

Get a charge batch by ID

Request​

Path Parameters

    id numberrequired

Header Parameters

    x-api-key stringrequired

    Gateway API key

Responses​

Charge batch details

Schema

    status number
    message string

    data

    object

    id numberrequired
    batchCode stringrequired
    status stringrequired

    Possible values: [PENDING, PROCESSED]

    submittedAt date-timerequired
    processedAt date-timerequired
    createdAt date-timerequired
    totalAmount numberrequired
    unpaidAmount numberrequired
    successRate numberrequired
    spendingLimitExceed numberrequired

    logs

    object[]

    required

  • Array [

    • id numberrequired

    Log ID

    batchId numberrequired

    Batch ID this log belongs to

    userChargeId stringrequired

    User charge ID this log is associated with

    userName stringrequired

    Name of the user associated with this charge

    status stringrequired

    Possible values: [PENDING, SUCCESS, FAILED]

    Processing status of this charge in the batch

    responseMessage stringrequired

    Response message from processing, if any

    amount numberrequired

    Amount of the charge

    originatedEvent stringrequired

    Originated event of the charge

    attemptIndex numberrequired

    Number of attempts made to process this charge

    isLatest booleanrequired

    Whether this is the latest attempt for this charge

    createdAt date-timerequired

    When this log was created

    batchCode stringrequired

    Batch code of this log

  • ]

Loading...