API reference · Platform & integration

Open Banking Variable Recurring Payments API

POST/openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consentsCreate a VRP consent
DELETE/openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}Revoke a VRP consent
GET/openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}Read a VRP consent
POST/openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}/funds-confirmationWould a payment of this amount be covered
POST/openbanking/{tenantId}/v3.1/pisp/domestic-vrpsTake a payment under a VRP consent
GET/openbanking/{tenantId}/v3.1/pisp/domestic-vrps/{paymentId}Read a VRP payment
GET/openbanking/{tenantId}/v3.1/pisp/domestic-vrps/{paymentId}/payment-detailsThe status history of a VRP payment

POST Create a VRP consent

POST /openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents

Client-credentials token with scope payments, x-idempotency-key and x-jws-signature. ControlParameters name the maximum per payment and at least one periodic limit; every debit is checked against them at the moment it is made.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`x-idempotency-key`	Reuse the same value on every retry of this request
`x-jws-signature`
`Content-Type`	application/json

Path parameters

Name
`tenantId`

Example

Request body: string · Response: ObResponseVrpConsentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrp-consents" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "x-idempotency-key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "ControlParameters": "string",
    "Initiation": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

DELETE Revoke a VRP consent

DELETE /openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}

Revokes it and every token issued under it.

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

curl -X DELETE "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrp-consents/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

Status	When
`200`	OK

GET Read a VRP consent

GET /openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponseVrpConsentData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrp-consents/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "ControlParameters": "string",
    "Initiation": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

POST Would a payment of this amount be covered

POST /openbanking/{tenantId}/v3.1/pisp/domestic-vrp-consents/{consentId}/funds-confirmation

A yes or no, including the fee; never a balance.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`tenantId`
`consentId`

Example

Request body: string · Response: ObResponseVrpFundsConfirmationData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrp-consents/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/funds-confirmation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "FundsConfirmationId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "string",
      "FundsAvailable": true
    },
    "InstructedAmount": {
      "Amount": "string",
      "Currency": "string"
    }
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

POST Take a payment under a VRP consent

POST /openbanking/{tenantId}/v3.1/pisp/domestic-vrps

Authorization-code token for the authorised consent. Refused whole, never reduced, when it would breach a control parameter; the refusal is recorded and notified.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`x-idempotency-key`	Reuse the same value on every retry of this request
`x-jws-signature`
`Content-Type`	application/json

Path parameters

Name
`tenantId`

Example

Request body: string · Response: ObResponseVrpData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrps" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "x-idempotency-key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "DomesticVRPId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "StatusReason": "string",
    "Initiation": "string",
    "Instruction": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

GET Read a VRP payment

GET /openbanking/{tenantId}/v3.1/pisp/domestic-vrps/{paymentId}

Headers

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

Path parameters

Name
`tenantId`
`paymentId`

Example

Response: ObResponseVrpData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrps/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "Data": {
    "DomesticVRPId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "StatusReason": "string",
    "Initiation": "string",
    "Instruction": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

GET The status history of a VRP payment

GET /openbanking/{tenantId}/v3.1/pisp/domestic-vrps/{paymentId}/payment-details

Headers

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

Path parameters

Name
`tenantId`
`paymentId`

Example

Response: ObResponsePaymentDetailsData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-vrps/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/payment-details" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "Data": {
    "PaymentStatus": [
      {
        "PaymentTransactionId": "string",
        "Status": "string",
        "StatusUpdateDateTime": "string",
        "StatusDetail": {
          "Status": "string",
          "StatusReason": "string",
          "StatusReasonDescription": "string"
        }
      }
    ]
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

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