API reference · Cards & gift cards

Card servicing

POST Report a delivery change

POST /card/delivery/event

Called by the provider as the plastic moves from production to the door.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
x-api-key
x-bridge-signature
Content-Typeapplication/json

Example

Request body: string · Response: GenericResponseCardDeliveryResponse

curl -X POST "https://api.bridgemoni.com/card/delivery/event" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

Responses

StatusWhen
200OK

POST Dispute a card transaction

POST /card/dispute

Opens a chargeback on a settled purchase the holder does not recognise or did not receive. Where the tenant allows it the disputed amount is credited provisionally at once and reversed only if the dispute is lost, with the holder told first.

Headers

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

Example

Request body: RaiseCardDisputeRequest · Response: GenericResponseCardDisputeResponse

curl -X POST "https://api.bridgemoni.com/card/dispute" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "cardTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "reasonCode": "string",
  "amount": 0,
  "evidenceDocumentReferences": [
    "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  ]
}'

Responses

StatusWhen
200OK

GET Read a dispute

GET /card/dispute/{disputeReference}

Headers

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

Path parameters

Name
disputeReference

Example

Response: GenericResponseCardDisputeResponse

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

Responses

StatusWhen
200OK

POST Move a dispute to its next stage

POST /card/dispute/{disputeReference}/stage

For the dispute analyst. Only the transitions of the dispute lifecycle are accepted, and a missed deadline moves the dispute on its own.

Headers

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

Path parameters

Name
disputeReference

Example

Request body: AdvanceCardDisputeRequest · Response: GenericResponseCardDisputeResponse

curl -X POST "https://api.bridgemoni.com/card/dispute/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/stage" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "RETRIEVAL",
  "note": "string"
}'

Responses

StatusWhen
200OK

POST Fund the card float account

POST /card/float/fund

Moves tenant money into the card float account the sweeper tops providers up from.

Headers

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

Example

Request body: FundCardFloatRequest · Response: GenericResponseCardFloatPositionResponse

curl -X POST "https://api.bridgemoni.com/card/float/fund" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "10000.00",
  "currencyCode": "NGN"
}'

Responses

StatusWhen
200OK

GET Provider float positions

GET /card/float/positions

Headers

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

Example

Response: GenericResponseListCardFloatPositionResponse

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

Responses

StatusWhen
200OK

POST Report a wallet token change

POST /card/token/event

Called by the provider when a network token is provisioned or changes state.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
x-api-key
x-bridge-signature
Content-Typeapplication/json

Example

Request body: string · Response: GenericResponseCardDigitalTokenResponse

curl -X POST "https://api.bridgemoni.com/card/token/event" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

Responses

StatusWhen
200OK

POST Send a physical card to the holder

POST /card/{reference}/delivery

Headers

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

Path parameters

Name
reference

Example

Request body: RequestCardDeliveryRequest · Response: GenericResponseCardUpgradeResponse

curl -X POST "https://api.bridgemoni.com/card/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/delivery" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "courier": "string"
}'

Responses

StatusWhen
200OK

GET List a card's disputes

GET /card/{reference}/disputes

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseListCardDisputeResponse

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

Responses

StatusWhen
200OK

POST Confirm the plastic arrived

POST /card/{reference}/physical/activate

Opens terminal, ATM and contactless spend. Accepted once the courier reports the card in transit or delivered.

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseCardUpgradeResponse

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

Responses

StatusWhen
200OK

GET Card statement

GET /card/{reference}/statement

Settled transactions in the period with their totals, and the holds still pending. At most a year per request.

Headers

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

Path parameters

Name
reference

Query parameters

NameDefault
fromOptional
toOptional

Example

Response: GenericResponseCardStatementResponse

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

Responses

StatusWhen
200OK

POST Suspend, resume or delete a wallet token

POST /card/{reference}/token/{tokenReference}/{action}

The action is one of suspend, resume or delete. A deleted token is gone.

Headers

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

Path parameters

Name
reference
tokenReference
action

Example

Response: GenericResponseCardDigitalTokenResponse

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

Responses

StatusWhen
200OK

GET List a card's wallet tokens

GET /card/{reference}/tokens

Headers

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

Path parameters

Name
reference

Example

Response: GenericResponseListCardDigitalTokenResponse

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

Responses

StatusWhen
200OK

POST Upgrade a virtual card to plastic

POST /card/{reference}/upgrade

The same card, the same number and the same reference: every subscription and wallet token keeps working. Online spend is unaffected; terminal spend waits until the holder confirms the plastic arrived.

Headers

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

Path parameters

Name
reference

Example

Request body: RequestCardDeliveryRequest · Response: GenericResponseCardUpgradeResponse

curl -X POST "https://api.bridgemoni.com/card/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/upgrade" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "addressReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "courier": "string"
}'

Responses

StatusWhen
200OK

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