# Payment Initiation API API

> Payment Initiation API API on Apizie: 41 endpoints (Create Domestic Payment Consents, Get Domestic Payment Consents, Get Domestic Payment Consents Funds Confirmation, Create Domestic Payments, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:openbanking-org-uk-payment-initiation-openapi`
- Category: Finance
- Status: byok
- Source: https://openbanking.org.uk
- Page: https://apizie.tech/api/finance/openbanking-org-uk-payment-initiation-openapi
- OpenAPI: https://apizie.tech/api/finance/openbanking-org-uk-payment-initiation-openapi/openapi.json

Swagger for Payment Initiation API Specification

## Endpoints

### Create Domestic Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-payment-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-payment-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Payment Consents Funds Confirmation
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-payment-consents-consent-id-funds-confirmation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create Domestic Payments
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-payments-domestic-payment-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticPaymentId | string | yes | DomesticPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-payments-domestic-payment-id-payment-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticPaymentId | string | yes | DomesticPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create Domestic Scheduled Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-scheduled-payment-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Scheduled Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-scheduled-payment-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create Domestic Scheduled Payments
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-scheduled-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Scheduled Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-scheduled-payments-domestic-scheduled-payment-i` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticScheduledPaymentId | string | yes | DomesticScheduledPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-scheduled-payments-domestic-scheduled-payment-i-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticScheduledPaymentId | string | yes | DomesticScheduledPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create Domestic Standing Order Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-standing-order-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Standing Order Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-standing-order-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create Domestic Standing Orders
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-standing-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Domestic Standing Orders
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-standing-orders-domestic-standing-order-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticStandingOrderId | string | yes | DomesticStandingOrderId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-domestic-standing-orders-domestic-standing-order-id-paym` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DomesticStandingOrderId | string | yes | DomesticStandingOrderId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create File Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-file-payment-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get File Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-file-payment-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get File Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-file-payment-consents-consent-id-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create File Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-file-payment-consents-consent-id-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create File Payments
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-file-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get File Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-file-payments-file-payment-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FilePaymentId | string | yes | FilePaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-file-payments-file-payment-id-payment-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FilePaymentId | string | yes | FilePaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get File Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-file-payments-file-payment-id-report-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| FilePaymentId | string | yes | FilePaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-payment-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-payment-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Payment Consents Funds Confirmation
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-payment-consents-consent-id-funds-confirma` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Payments
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-payments-international-payment-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalPaymentId | string | yes | InternationalPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-payments-international-payment-id-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalPaymentId | string | yes | InternationalPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Scheduled Payment Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-scheduled-payment-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Scheduled Payment Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-scheduled-payment-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Scheduled Payment Consents Funds Confirmation
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-scheduled-payment-consents-consent-id-fund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Scheduled Payments
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-scheduled-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Scheduled Payments
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-scheduled-payments-international-scheduled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalScheduledPaymentId | string | yes | InternationalScheduledPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-scheduled-payments-international-scheduled-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalScheduledPaymentId | string | yes | InternationalScheduledPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Standing Order Consents
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-standing-order-consents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Standing Order Consents
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-standing-order-consents-consent-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConsentId | string | yes | ConsentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Create International Standing Orders
`POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-international-standing-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-idempotency-key | string | yes | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. |
| x-jws-signature | string | yes | A detached JWS signature of the body of the payload. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get International Standing Orders
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-standing-orders-international-standing-ord` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalStandingOrderPaymentId | string | yes | InternationalStandingOrderPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

### Get Payment Details
`GET https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/get-international-standing-orders-international-standing-ord-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InternationalStandingOrderPaymentId | string | yes | InternationalStandingOrderPaymentId |
| x-fapi-auth-date | string | no | The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is… |
| x-fapi-customer-ip-address | string | no | The PSU's IP address if the PSU is currently logged in with the TPP. |
| x-fapi-interaction-id | string | no | An RFC4122 UID used as a correlation id. |
| x-customer-user-agent | string | no | Indicates the user-agent that the PSU is using. |

## Example
```
curl "https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-payment-consents" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Payment Initiation API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/finance:openbanking-org-uk-payment-initiation-openapi/create-domestic-payment-consents with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Payment Initiation API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Payment Initiation API itself also needs your own key from openbanking.org.uk.

### Can AI agents use the Payment Initiation API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:openbanking-org-uk-payment-initiation-openapi.

### What is the status of the Payment Initiation API API?
Needs your own provider key (bring your own key)