APIHub
Back to Explore

Payment Initiation API

Swagger for Payment Initiation API Specification

Finance
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/domestic-payment-consents

Create Domestic Payment Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-payment-consents/{ConsentId}

Get Domestic Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-payment-consents/{ConsentId}/funds-confirmation

Get Domestic Payment Consents Funds Confirmation

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/domestic-payments

Create Domestic Payments

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-payments/{DomesticPaymentId}

Get Domestic Payments

  • DomesticPaymentId (path, required) — DomesticPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-payments/{DomesticPaymentId}/payment-details

Get Payment Details

  • DomesticPaymentId (path, required) — DomesticPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/domestic-scheduled-payment-consents

Create Domestic Scheduled Payment Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-scheduled-payment-consents/{ConsentId}

Get Domestic Scheduled Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/domestic-scheduled-payments

Create Domestic Scheduled Payments

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-scheduled-payments/{DomesticScheduledPaymentId}

Get Domestic Scheduled Payments

  • DomesticScheduledPaymentId (path, required) — DomesticScheduledPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details

Get Payment Details

  • DomesticScheduledPaymentId (path, required) — DomesticScheduledPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/domestic-standing-order-consents

Create Domestic Standing Order Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-standing-order-consents/{ConsentId}

Get Domestic Standing Order Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/domestic-standing-orders

Create Domestic Standing Orders

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-standing-orders/{DomesticStandingOrderId}

Get Domestic Standing Orders

  • DomesticStandingOrderId (path, required) — DomesticStandingOrderId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/domestic-standing-orders/{DomesticStandingOrderId}/payment-details

Get Payment Details

  • DomesticStandingOrderId (path, required) — DomesticStandingOrderId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/file-payment-consents

Create File Payment Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/file-payment-consents/{ConsentId}

Get File Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/file-payment-consents/{ConsentId}/file

Get File Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/file-payment-consents/{ConsentId}/file

Create File Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/file-payments

Create File Payments

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/file-payments/{FilePaymentId}

Get File Payments

  • FilePaymentId (path, required) — FilePaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/file-payments/{FilePaymentId}/payment-details

Get Payment Details

  • FilePaymentId (path, required) — FilePaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/file-payments/{FilePaymentId}/report-file

Get File Payments

  • FilePaymentId (path, required) — FilePaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-payment-consents

Create International Payment Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-payment-consents/{ConsentId}

Get International Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-payment-consents/{ConsentId}/funds-confirmation

Get International Payment Consents Funds Confirmation

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-payments

Create International Payments

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-payments/{InternationalPaymentId}

Get International Payments

  • InternationalPaymentId (path, required) — InternationalPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-payments/{InternationalPaymentId}/payment-details

Get Payment Details

  • InternationalPaymentId (path, required) — InternationalPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-scheduled-payment-consents

Create International Scheduled Payment Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-scheduled-payment-consents/{ConsentId}

Get International Scheduled Payment Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-scheduled-payment-consents/{ConsentId}/funds-confirmation

Get International Scheduled Payment Consents Funds Confirmation

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-scheduled-payments

Create International Scheduled Payments

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-scheduled-payments/{InternationalScheduledPaymentId}

Get International Scheduled Payments

  • InternationalScheduledPaymentId (path, required) — InternationalScheduledPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details

Get Payment Details

  • InternationalScheduledPaymentId (path, required) — InternationalScheduledPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-standing-order-consents

Create International Standing Order Consents

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-standing-order-consents/{ConsentId}

Get International Standing Order Consents

  • ConsentId (path, required) — ConsentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
POST

/international-standing-orders

Create International Standing Orders

  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-idempotency-key (header, required) — Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
  • x-jws-signature (header, required) — A detached JWS signature of the body of the payload.
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-standing-orders/{InternationalStandingOrderPaymentId}

Get International Standing Orders

  • InternationalStandingOrderPaymentId (path, required) — InternationalStandingOrderPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.
GET

/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details

Get Payment Details

  • InternationalStandingOrderPaymentId (path, required) — InternationalStandingOrderPaymentId
  • x-fapi-auth-date (header) — 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 below: Sun, 10 Sep 2017 19:43:31 UTC
  • x-fapi-customer-ip-address (header) — The PSU's IP address if the PSU is currently logged in with the TPP.
  • x-fapi-interaction-id (header) — An RFC4122 UID used as a correlation id.
  • Authorization (header, required) — An Authorisation Token as per https://tools.ietf.org/html/rfc6750
  • x-customer-user-agent (header) — Indicates the user-agent that the PSU is using.

41 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://openbanking.org.uk/domestic-payment-consents"

openbanking.org.uk · HTTPS only