Process a charge batch

POST 
/api/gateway/v1/user-billing/charge-batches/:code/process

Process a charge batch

Request

Path Parameters

code stringrequired

Header Parameters

x-api-key stringrequired

Gateway API key

application/json

Body

required

batchCode stringrequired

chargeResults

object[]

required

Array [

userChargeId stringrequired

User charge ID

status stringrequired

Possible values: [PENDING, SUCCESS, FAILED]

Processing status

responseMessage string

Response message from processing

]

Responses

200

Batch processed successfully

application/json

Schema

Schema

status number
message string
meta object

Example (from schema)

{
  "status": 200,
  "message": "OK",
  "meta": {
    "count": 1
  }
}

400

Cannot process non-pending batch or invalid charge results

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 400,
  "message": "Cannot process non-pending batch or invalid charge results",
  "error": {
    "code": "string",
    "detail": "Cannot process non-pending batch or invalid charge results"
  }
}

401

Unauthorized

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 401,
  "message": "Invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "detail": "Invalid API key"
  }
}

404

Batch not found

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 404,
  "message": "Batch not found",
  "error": {
    "code": "string",
    "detail": "Batch not found"
  }
}

Loading...