Bridge
Contact us
API reference · Moving money

Disbursements

JSON or CSV runs, every line validated, maker-checker approval with PIN. About bulk payouts Next

GET List a disburser's batches

GET /disbursement/batch

Newest first.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
disburserReferenceOptional
statusOptional
page0
size20

Example

Response: GenericResponseBatchPageResponse

curl -X GET "https://api.bridgemoni.com/disbursement/batch?disburserReference=value&page=value&size=20" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Submit a batch

POST /disbursement/batch

Up to 1,000 lines inline. Validation runs asynchronously; poll the batch until it is VALIDATED. Replaying the same Idempotency-Key returns the first batch.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Idempotency-KeyReuse the same value on every retry of this request
Content-Typeapplication/json

Example

Request body: BatchRequest · Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "batchName": "string",
  "fundingAccountNumber": "string",
  "items": [
    {
      "clientReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "corridor": {
        "sendCountry": "string",
        "sendCurrency": "string",
        "receiveCountry": "string",
        "receiveCurrency": "string",
        "deliveryMethod": "BRIDGE_WALLET"
      },
      "amountType": "SEND_AMOUNT",
      "amount": "string",
      "recipient": {
        "type": "PERSON",
        "firstName": "Ada",
        "lastName": "Okafor",
        "organisationName": "string",
        "dateOfBirth": "1990-01-01",
        "placeOfBirth": {
          "city": "string",
          "country": "string"
        },
        "nationality": "string",
        "address": {
          "streetName": "string",
          "buildingNumber": "string",
          "postCode": "string",
          "townName": "string",
          "countrySubDivision": "string",
          "country": "string"
        },
        "identification": {
          "type": "string",
          "number": "string",
          "issuingCountry": "string"
        },
        "account": {
          "scheme": "IBAN",
          "iban": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "bankCode": "string",
          "bic": "string",
          "msisdn": "+2348000000000",
          "walletId": "string"
        },
        "msisdn": "+2348000000000",
        "relationship": "string"
      },
      "ultimateSender": {
        "type": "PERSON",
        "firstName": "Ada",
        "lastName": "Okafor",
        "organisationName": "string",
        "dateOfBirth": "1990-01-01",
        "placeOfBirth": {
          "city": "string",
          "country": "string"
        },
        "nationality": "string",
        "address": {
          "streetName": "string",
          "buildingNumber": "string",
          "postCode": "string",
          "townName": "string",
          "countrySubDivision": "string",
          "country": "string"
        },
        "identification": {
          "type": "string",
          "number": "string",
          "issuingCountry": "string"
        },
        "account": {
          "scheme": "IBAN",
          "iban": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "bankCode": "string",
          "bic": "string",
          "msisdn": "+2348000000000",
          "walletId": "string"
        },
        "msisdn": "+2348000000000",
        "relationship": "string"
      },
      "purpose": "string",
      "sourceOfFunds": "string",
      "narrative": "string"
    }
  ]
}'

Responses

StatusWhen
200OK

POST Submit a batch as a CSV file

POST /disbursement/batch/upload

UTF-8 CSV up to 25 MB and 100,000 lines with the header client_reference, rail, recipient_name, recipient_phone, recipient_email, account_number, provider_code, country_code, beneficiary_reference, amount, narration. Validation runs asynchronously.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Idempotency-KeyReuse the same value on every retry of this request
Content-Typemultipart/form-data

Query parameters

NameDefault
disburserReferenceOptional
titleOptional
currencyCodeOptional
scheduledForOptional

Example

Request body: object · Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/upload?disburserReference=value&title=value&currencyCode=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@./document.pdf"

Responses

StatusWhen
200OK

GET Read a batch

GET /disbursement/batch/{reference}

Totals count only lines that can be paid. The content digest is what an approver signs.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X GET "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Cancel a batch

POST /disbursement/batch/{reference}/cancel

Before funding nothing moves. After funding, every line not yet paid is cancelled and refunded; lines already sent to a bank are left to finish.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/cancel" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List a batch's lines

GET /disbursement/batch/{reference}/item

Every line carries every finding at once, with the supplied and resolved names side by side.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Query parameters

NameDefault
statusOptional
page0
size100

Example

Response: GenericResponseItemPageResponse

curl -X GET "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/item?page=value&size=100" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Accept or exclude a flagged line

POST /disbursement/batch/{reference}/item/{itemReference}/review

Accepting needs a reason, which is recorded with who decided. A line is never edited after validation; fix it and upload again.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
reference
itemReference

Example

Request body: ReviewRequest · Response: GenericResponseItemResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/item/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/review" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "PROPERTY",
  "rating": 4,
  "body": "Repairs were handled within a week"
}'

Responses

StatusWhen
200OK

POST Pause an executing batch

POST /disbursement/batch/{reference}/pause

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/pause" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET Download the batch report

GET /disbursement/batch/{reference}/report

One CSV row per line with its final status, provider reference and failure reason. Account numbers are masked.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: string

curl -X GET "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/report" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Resume a paused batch

POST /disbursement/batch/{reference}/resume

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/resume" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Revalidate a batch

POST /disbursement/batch/{reference}/revalidate

Re-runs every check on every payable line, for example after a stale name enquiry.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/revalidate" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Send a batch for approval

POST /disbursement/batch/{reference}/submit

Refused while a line still needs a review decision or a batch-level limit blocks it.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/batch/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/submit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Claim payments held for you

POST /disbursement/claim

Pays every unclaimed disbursement held for the verified phone number on your profile into your wallet in that currency.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Example

Response: GenericResponseListItemResponse

curl -X POST "https://api.bridgemoni.com/disbursement/claim" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List disbursers

GET /disbursement/disburser

Newest first. Page size is capped at 100.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
page0
size20

Example

Response: GenericResponseListDisburserResponse

curl -X GET "https://api.bridgemoni.com/disbursement/disburser?page=value&size=20" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET Read a disburser

GET /disbursement/disburser/{reference}

Carries every currency the disburser is funded in, with its funding and clearing accounts.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseDisburserResponse

curl -X GET "https://api.bridgemoni.com/disbursement/disburser/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List operators

GET /disbursement/disburser/{reference}/operator

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseListOperatorResponse

curl -X GET "https://api.bridgemoni.com/disbursement/disburser/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/operator" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List approval tiers

GET /disbursement/disburser/{reference}/tier

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseListApprovalTierResponse

curl -X GET "https://api.bridgemoni.com/disbursement/disburser/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/tier" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET Read one line

GET /disbursement/item/{reference}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseItemResponse

curl -X GET "https://api.bridgemoni.com/disbursement/item/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET Read a line's history

GET /disbursement/item/{reference}/event

Every transition, what caused it and who.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseListItemEventResponse

curl -X GET "https://api.bridgemoni.com/disbursement/item/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/event" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Reissue a failed or returned line

POST /disbursement/item/{reference}/reissue

Creates a new single-line batch under the same client reference with a ~r suffix. It is validated and approved like any other batch.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseBatchResponse

curl -X POST "https://api.bridgemoni.com/disbursement/item/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/reissue" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Ask the provider about a line now

POST /disbursement/item/{reference}/requery

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseItemResponse

curl -X POST "https://api.bridgemoni.com/disbursement/item/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/requery" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List provider lanes

GET /disbursement/lane

Shows each lane's circuit state. OPEN means dispatch is paused; lines wait in the queue and are never sent into a provider that is failing.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Example

Response: GenericResponseListProviderLaneResponse

curl -X GET "https://api.bridgemoni.com/disbursement/lane" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET The operator queue

GET /disbursement/review

Lines in manual review, held by fraud policy or screening, and lines the provider has not answered.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
page0
size100

Example

Response: GenericResponseItemPageResponse

curl -X GET "https://api.bridgemoni.com/disbursement/review?page=value&size=100" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

GET List recurring disbursements

GET /disbursement/schedule

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Query parameters

NameDefault
disburserReferenceOptional

Example

Response: GenericResponseListScheduleResponse

curl -X GET "https://api.bridgemoni.com/disbursement/schedule?disburserReference=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Create a recurring disbursement

POST /disbursement/schedule

Each occurrence becomes an ordinary batch that is validated and approved. Client references get the occurrence date appended so each run is its own instruction.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Example

Request body: ScheduleRequest · Response: GenericResponseScheduleResponse

curl -X POST "https://api.bridgemoni.com/disbursement/schedule" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "disburserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "title": "string",
  "currencyCode": "string",
  "frequency": "WEEKLY",
  "firstRunAt": "2026-09-25T10:00:00Z",
  "endsAt": "2026-09-25T10:00:00Z",
  "standingMandate": true,
  "items": [
    {
      "clientReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "corridor": {
        "sendCountry": "string",
        "sendCurrency": "string",
        "receiveCountry": "string",
        "receiveCurrency": "string",
        "deliveryMethod": "BRIDGE_WALLET"
      },
      "amountType": "SEND_AMOUNT",
      "amount": "string",
      "recipient": {
        "type": "PERSON",
        "firstName": "Ada",
        "lastName": "Okafor",
        "organisationName": "string",
        "dateOfBirth": "1990-01-01",
        "placeOfBirth": {
          "city": "string",
          "country": "string"
        },
        "nationality": "string",
        "address": {
          "streetName": "string",
          "buildingNumber": "string",
          "postCode": "string",
          "townName": "string",
          "countrySubDivision": "string",
          "country": "string"
        },
        "identification": {
          "type": "string",
          "number": "string",
          "issuingCountry": "string"
        },
        "account": {
          "scheme": "IBAN",
          "iban": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "bankCode": "string",
          "bic": "string",
          "msisdn": "+2348000000000",
          "walletId": "string"
        },
        "msisdn": "+2348000000000",
        "relationship": "string"
      },
      "ultimateSender": {
        "type": "PERSON",
        "firstName": "Ada",
        "lastName": "Okafor",
        "organisationName": "string",
        "dateOfBirth": "1990-01-01",
        "placeOfBirth": {
          "city": "string",
          "country": "string"
        },
        "nationality": "string",
        "address": {
          "streetName": "string",
          "buildingNumber": "string",
          "postCode": "string",
          "townName": "string",
          "countrySubDivision": "string",
          "country": "string"
        },
        "identification": {
          "type": "string",
          "number": "string",
          "issuingCountry": "string"
        },
        "account": {
          "scheme": "IBAN",
          "iban": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "bankCode": "string",
          "bic": "string",
          "msisdn": "+2348000000000",
          "walletId": "string"
        },
        "msisdn": "+2348000000000",
        "relationship": "string"
      },
      "purpose": "string",
      "sourceOfFunds": "string",
      "narrative": "string"
    }
  ]
}'

Responses

StatusWhen
200OK

POST End a recurring disbursement

POST /disbursement/schedule/{reference}/end

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseScheduleResponse

curl -X POST "https://api.bridgemoni.com/disbursement/schedule/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/end" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Pause a recurring disbursement

POST /disbursement/schedule/{reference}/pause

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseScheduleResponse

curl -X POST "https://api.bridgemoni.com/disbursement/schedule/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/pause" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

POST Resume a recurring disbursement

POST /disbursement/schedule/{reference}/resume

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseScheduleResponse

curl -X POST "https://api.bridgemoni.com/disbursement/schedule/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/resume" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200OK

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors