API reference · Platform & integration

Open Banking Payment Initiation API

POST/openbanking/{tenantId}/v3.1/pisp/domestic-payment-consentsCreate a consent for a single domestic payment, made at once
GET/openbanking/{tenantId}/v3.1/pisp/domestic-payment-consents/{consentId}Read a consent for a single domestic payment, made at once
GET/openbanking/{tenantId}/v3.1/pisp/domestic-payment-consents/{consentId}/funds-confirmationWould the authorised domestic payment be covered
POST/openbanking/{tenantId}/v3.1/pisp/domestic-paymentsSubmit a single domestic payment, made at once
GET/openbanking/{tenantId}/v3.1/pisp/domestic-payments/{paymentId}Read a single domestic payment, made at once
GET/openbanking/{tenantId}/v3.1/pisp/domestic-payments/{paymentId}/payment-detailsThe status history of a single domestic payment, made at once
POST/openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-payment-consentsCreate a consent for a single domestic payment on a future date
GET/openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-payment-consents/{consentId}Read a consent for a single domestic payment on a future date
POST/openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-paymentsSubmit a single domestic payment on a future date
GET/openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-payments/{paymentId}Read a single domestic payment on a future date
GET/openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-payments/{paymentId}/payment-detailsThe status history of a single domestic payment on a future date
POST/openbanking/{tenantId}/v3.1/pisp/domestic-standing-order-consentsCreate a consent for a recurring domestic payment
GET/openbanking/{tenantId}/v3.1/pisp/domestic-standing-order-consents/{consentId}Read a consent for a recurring domestic payment
POST/openbanking/{tenantId}/v3.1/pisp/domestic-standing-ordersSubmit a recurring domestic payment
GET/openbanking/{tenantId}/v3.1/pisp/domestic-standing-orders/{paymentId}Read a recurring domestic payment
GET/openbanking/{tenantId}/v3.1/pisp/domestic-standing-orders/{paymentId}/payment-detailsThe status history of a recurring domestic payment

POST Create a consent for a single domestic payment, made at once

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

Client-credentials token with scope payments, an x-idempotency-key, and an x-jws-signature over the exact body. The Initiation is stored verbatim and digested; the submission must repeat it exactly.

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: ObResponsePaymentConsentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-payment-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",
    "Permission": "string",
    "ExpirationDateTime": "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

GET Read a consent for a single domestic payment, made at once

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

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponsePaymentConsentData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-payment-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",
    "Permission": "string",
    "ExpirationDateTime": "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

GET Would the authorised domestic payment be covered

GET /openbanking/{tenantId}/v3.1/pisp/domestic-payment-consents/{consentId}/funds-confirmation

Authorization-code token for the authorised consent. A yes or no against the available balance including the fee the payment would be charged; never a balance.

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponseFundsConfirmationData

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

{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "string",
      "FundsAvailable": true
    }
  },
  "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 Submit a single domestic payment, made at once

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

Authorization-code token bound to the authorised consent. The consent is consumed before any money moves, so it can pay at most once; a refusal from the ledger is recorded as a Rejected payment, not lost.

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: ObResponsePaymentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-payments" \
  -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": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET Read a single domestic payment, made at once

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

Headers

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

Path parameters

Name
`tenantId`
`paymentId`

Example

Response: ObResponsePaymentData

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

{
  "Data": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET The status history of a single domestic payment, made at once

GET /openbanking/{tenantId}/v3.1/pisp/domestic-payments/{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-payments/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

POST Create a consent for a single domestic payment on a future date

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

Client-credentials token with scope payments, an x-idempotency-key, and an x-jws-signature over the exact body. The Initiation is stored verbatim and digested; the submission must repeat it exactly.

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: ObResponsePaymentConsentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-scheduled-payment-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",
    "Permission": "string",
    "ExpirationDateTime": "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

GET Read a consent for a single domestic payment on a future date

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

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponsePaymentConsentData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-scheduled-payment-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",
    "Permission": "string",
    "ExpirationDateTime": "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 Submit a single domestic payment on a future date

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

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: ObResponsePaymentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-scheduled-payments" \
  -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": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET Read a single domestic payment on a future date

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

Headers

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

Path parameters

Name
`tenantId`
`paymentId`

Example

Response: ObResponsePaymentData

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

{
  "Data": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET The status history of a single domestic payment on a future date

GET /openbanking/{tenantId}/v3.1/pisp/domestic-scheduled-payments/{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-scheduled-payments/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

POST Create a consent for a recurring domestic payment

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

Client-credentials token with scope payments, an x-idempotency-key, and an x-jws-signature over the exact body. The Initiation is stored verbatim and digested; the submission must repeat it exactly.

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: ObResponsePaymentConsentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-standing-order-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",
    "Permission": "string",
    "ExpirationDateTime": "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

GET Read a consent for a recurring domestic payment

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

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponsePaymentConsentData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-standing-order-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",
    "Permission": "string",
    "ExpirationDateTime": "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 Submit a recurring domestic payment

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

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: ObResponsePaymentData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/pisp/domestic-standing-orders" \
  -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": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET Read a recurring domestic payment

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

Headers

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

Path parameters

Name
`tenantId`
`paymentId`

Example

Response: ObResponsePaymentData

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

{
  "Data": {
    "DomesticPaymentId": "string",
    "DomesticScheduledPaymentId": "string",
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "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

GET The status history of a recurring domestic payment

GET /openbanking/{tenantId}/v3.1/pisp/domestic-standing-orders/{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-standing-orders/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