Get a bulk and its current progress

GET /v2/collections/bulks/{id}

Path parameters

  • id string(uuid) Required

    ID of the bulk.

Responses

  • • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string(uuid) Required

      ID of the bulk.

    • collections_total integer(int32) Required

      Total number of collections in the bulk.

    • collections_confirmed integer(int32) Required

      Number of collections that were processed and confirmed.

    • collections_canceled integer(int32) Required

      Number of collections canceled before processing.

    • collections_failed integer(int32) Required

      Number of collections that were processed and failed.

    • status string Required

      Aggregated status of the bulk.

      Values are pending or completed.
GET /v2/collections/bulks/{id} 
curl \
 -X GET https://api.memo.bank/v2/collections/bulks/6ba07619-24ff-43f3-b1f0-cdc9b06bf8a7 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "fe98f29d-5165-45ff-83f9-d7aa83e970b5",
  "collections_total": 3000,
  "collections_confirmed": 1552,
  "collections_canceled": 2,
  "collections_failed": 57,
  "status": "pending"
}