Mono Colombia
GuidesAPI reference

Gets a settlement batch

Gets a settlement batch by its ID, along with the payins it settles and what each one contributed. Scoped to the requesting client.

The response is the same shape the settlement_batch_* webhooks deliver.

GET
/v1/core/payins/settlement_batches/{id}

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Settlement batch ID

Match^[A-Za-z]{2,7}_[\w-]{22}$
Example"cpisb_5tgliBmzjZ6mpQPRbQjfKj"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.sandbox.cuentamono.com/v1/core/payins/settlement_batches/cpisb_5tgliBmzjZ6mpQPRbQjfKj"
{
  "funding_account_id": "facc_5tgliBmzjZ6mpQPRbQjfKj",
  "id": "cpisb_5tgliBmzjZ6mpQPRbQjfKj",
  "inserted_at": "2022-01-01T01:00:00Z",
  "method": "co_breb",
  "state": "created",
  "total_amount": {
    "amount": 1100000000,
    "currency": "COP"
  },
  "updated_at": "2022-01-01T01:00:00Z",
  "payins": [
    {
      "amount": {
        "amount": 500000000,
        "currency": "COP"
      },
      "funding_amount": {
        "amount": 500000000,
        "currency": "COP"
      },
      "funding_amount_rates": {},
      "id": "cpin_5tgliBmzjZ6mpQPRbQjfKj"
    }
  ]
}
{
  "code": "401 Unauthorized",
  "errors": [
    {
      "error_code": "missing_authorization_header",
      "message": "`Authorization` header is missing.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Authorization header is missing or invalid."
}
{
  "code": "403 Forbidden",
  "errors": [
    {
      "error_code": "not_authorized",
      "message": "Not authorized to have access to this resource.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Not authorized to have access to this resource"
}
{
  "code": "404 Not Found",
  "errors": [
    {
      "error_code": "settlement_batch_not_found",
      "message": "The settlement batch doesn't exist.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Resource not defined"
}
{
  "code": "422 Unprocessable Content",
  "errors": [
    {
      "error_code": "invalid_format",
      "message": "The field contains an invalid format.",
      "path": "#/path/to/field",
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Validation errors"
}