API reference · Platform & integration

GSMA grants, links, mandates and codes held by me

GET/gsma/me/approvalsList payment requests waiting for my approval
POST/gsma/me/approvals/{reference}/approveApprove a payment request
POST/gsma/me/approvals/{reference}/declineDecline a payment request
GET/gsma/me/grantsList the apps I have granted access to my wallet
DELETE/gsma/me/grants/{intentId}Revoke a grant
GET/gsma/me/linksList the account links on my accounts
DELETE/gsma/me/links/{reference}Revoke an account link
GET/gsma/me/mandatesList the debit mandates on my accounts
DELETE/gsma/me/mandates/{reference}Revoke a debit mandate

GET List payment requests waiting for my approval

GET /gsma/me/approvals

Merchant payments, agent cash-outs, mandates and links a third party asked me to approve.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListGsmaPendingApprovalResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "kind": "string",
      "clientName": "string",
      "amount": "string",
      "currency": "string",
      "description": "string",
      "expiresAt": "string"
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

POST Approve a payment request

POST /gsma/me/approvals/{reference}/approve

Needs my transaction PIN (x-secret-value). The payment moves at once.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseGsmaPendingApprovalResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "string",
    "clientName": "string",
    "amount": "string",
    "currency": "string",
    "description": "string",
    "expiresAt": "string"
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

POST Decline a payment request

POST /gsma/me/approvals/{reference}/decline

Needs no PIN.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseGsmaPendingApprovalResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "string",
    "clientName": "string",
    "amount": "string",
    "currency": "string",
    "description": "string",
    "expiresAt": "string"
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET List the apps I have granted access to my wallet

GET /gsma/me/grants

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListGsmaUserGrantResponse

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

{
  "data": [
    {
      "intentId": "string",
      "clientId": "string",
      "clientName": "string",
      "status": "AWAITING",
      "scopes": [
        "string"
      ],
      "accountNumbers": [
        "string"
      ],
      "perTransactionLimit": "string",
      "perDayLimit": "string",
      "currency": "string",
      "expiresAt": "string",
      "authorisedAt": "string"
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

DELETE Revoke a grant

DELETE /gsma/me/grants/{intentId}

Takes effect at the next request; the app's tokens are revoked with it.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`intentId`

Example

Response: GenericResponseGsmaUserGrantResponse

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

{
  "data": {
    "intentId": "string",
    "clientId": "string",
    "clientName": "string",
    "status": "AWAITING",
    "scopes": [
      "string"
    ],
    "accountNumbers": [
      "string"
    ],
    "perTransactionLimit": "string",
    "perDayLimit": "string",
    "currency": "string",
    "expiresAt": "string",
    "authorisedAt": "string"
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET List the account links on my accounts

GET /gsma/me/links

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListMmLink

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

{
  "data": [
    {
      "linkReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "sourceAccountIdentifiers": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "mode": "string",
      "status": "string",
      "requestingOrganisation": {
        "requestingOrganisationIdentifierType": "string",
        "requestingOrganisationIdentifier": "string"
      },
      "requestDate": "string",
      "creationDate": "string",
      "modificationDate": "string",
      "customData": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

DELETE Revoke an account link

DELETE /gsma/me/links/{reference}

The link becomes inactive at once.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseMmLink

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

{
  "data": {
    "linkReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sourceAccountIdentifiers": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "mode": "string",
    "status": "string",
    "requestingOrganisation": {
      "requestingOrganisationIdentifierType": "string",
      "requestingOrganisationIdentifier": "string"
    },
    "requestDate": "string",
    "creationDate": "string",
    "modificationDate": "string",
    "customData": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET List the debit mandates on my accounts

GET /gsma/me/mandates

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListMmDebitMandate

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

{
  "data": [
    {
      "mandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "payee": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "mandateStatus": "string",
      "startDate": "string",
      "endDate": "string",
      "amountLimit": "string",
      "currency": "string",
      "frequencyType": "string",
      "numberOfPayments": 0,
      "requestingOrganisation": {
        "requestingOrganisationIdentifierType": "string",
        "requestingOrganisationIdentifier": "string"
      },
      "requestDate": "string",
      "creationDate": "string",
      "modificationDate": "string",
      "customData": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

DELETE Revoke a debit mandate

DELETE /gsma/me/mandates/{reference}

The next pull under it is refused.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseMmDebitMandate

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

{
  "data": {
    "mandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "payee": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "mandateStatus": "string",
    "startDate": "string",
    "endDate": "string",
    "amountLimit": "string",
    "currency": "string",
    "frequencyType": "string",
    "numberOfPayments": 0,
    "requestingOrganisation": {
      "requestingOrganisationIdentifierType": "string",
      "requestingOrganisationIdentifier": "string"
    },
    "requestDate": "string",
    "creationDate": "string",
    "modificationDate": "string",
    "customData": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

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