Payments | API Developer Portal

Description

Provide your users with the ability to initiate payments using one of the payment products made available in Portuguese homebankings. Get also access to the provisioning of personal finance and liquidity management services to both private and corporate clients.


P2P payments	Business to Business
SEPA credit transfers(SCT)	TARGET2 Payments
Worldwide Payments (Swift)	Instant Payments (SCT Inst)
Bulk Payments	TSU Payments
Bulk TSU Payments

APIs

Download API Specs (zip)

Payment Authorisation

4.0.0

The API is designed on a REST model using JSON structures.

REST

Online
Bulk TSU Payment Initiation

4.0.1

The Bulk TSU Payment Initiation API enables you to initiate a bulk TSU (Taxa Social Única) payment using the payment product made available by the Bank of the Payment Service User in his internet Banking. With this API it is possible to integrate this type of bulk TSU payments in an online store as well as to provide personal finance services to both private and corporate clients. The API is designed on a REST model using JSON structures.

REST

Online
Bulk Payments Initiation

4.0.1

The Payment Initiation API enables you to initiate a payment using one of the payment products made available by the Bank of the Payment Service User in his internet Banking.

With this API it is possible to integrate this type of of payments in an online store as well as to provide personal finance services to both private and corporate clients.

This API intends to provide an interface to access PSD2 Payments services.

The API is designed on a REST model using JSON structures.

REST

Online
TSU Payment Initiation

4.0.1

The TSU Payment Initiation API enables you to initiate a payment using one of the payment products made available by the Bank of the Payment Service User in his internet Banking.

With this API it is possible to integrate this type of of payments in an online store as well as to provide personal finance services to both private and corporate clients.

This API intends to provide an interface to access PSD2 Payments services.

The API is designed on a REST model using JSON structures.

REST

Online
Periodic Payments

4.0.1

The Payment Initiation API enables you to initiate a payment using one of the payment products made available by the Bank of the Payment Service User in his internet Banking.

With this API it is possible to integrate this type of of payments in an online store as well as to provide personal finance services to both private and corporate clients.

This API intends to provide an interface to access PSD2 Payments services.

The API is designed on a REST model using JSON structures.

REST

Online
Payment Initiation

4.0.0

The Payment Initiation API enables you to initiate a payment using one of the payment products made available by the Bank of the Payment Service User in his internet Banking.

With this API it is possible to integrate this type of of payments in an online store as well as to provide personal finance services to both private and corporate clients.

This API intends to provide an interface to access PSD2 Payments services.

The API is designed on a REST model using JSON structures.

REST

Online

Plans

In order to subscribe, you must create an account or sign in.

Sandbox Plan

200 calls per day

Select

Sandbox Plan

@number APIs including

Payment Initiation 4.0.0
Periodic Payments 4.0.1
TSU Payment Initiation 4.0.1
Bulk Payments Initiation 4.0.1
Bulk TSU Payment Initiation 4.0.1

View details

APIs

Title	Version	Type	Rate limits
Payment Initiation	4.0.0	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/payments/{payment-product}			200 calls per day
GET /{aspsp-cde}/v1-0-4/payments/{payment-product}/{payment-id}			200 calls per day
DELETE /{aspsp-cde}/v1-0-4/payments/{payment-product}/{payment-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/payments/{payment-product}/{payment-id}/status			200 calls per day
Periodic Payments	4.0.1	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}			200 calls per day
GET /{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}/{payment-id}			200 calls per day
DELETE /{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}/{payment-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/periodic-payments/{payment-product}/{payment-id}/status			200 calls per day
TSU Payment Initiation	4.0.1	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/tsu-payments/{payment-product}			200 calls per day
GET /{aspsp-cde}/v1-0-4/tsu-payments/{payment-product}/{payment-id}			200 calls per day
DELETE /{aspsp-cde}/v1-0-4/tsu-payments/{payment-product}/{payment-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/tsu-payments/{payment-product}/{payment-id}/status			200 calls per day
Bulk Payments Initiation	4.0.1	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/bulk-payments/{payment-product}			200 calls per day
GET /{aspsp-cde}/v1-0-4/bulk-payments/{payment-product}/{bulk-payment-id}			200 calls per day
DELETE /{aspsp-cde}/v1-0-4/bulk-payments/{payment-product}/{bulk-payment-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/bulk-payments/{payment-product}/{bulk-payment-id}/status			200 calls per day
Bulk TSU Payment Initiation	4.0.1	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/bulk-tsu-payments/{payment-product}			200 calls per day
GET /{aspsp-cde}/v1-0-4/bulk-tsu-payments/{payment-product}/{bulk-payment-id}			200 calls per day
DELETE /{aspsp-cde}/v1-0-4/bulk-tsu-payments/{payment-product}/{bulk-payment-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/bulk-tsu-payments/{payment-product}/{bulk-payment-id}/status			200 calls per day
Payment Authorisation	4.0.0	REST	200 calls per day
POST /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/authorisations			200 calls per day
GET /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/authorisations			200 calls per day
PUT /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/authorisations/{authorisation-id}			200 calls per day
POST /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations			200 calls per day
GET /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations			200 calls per day
PUT /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations/{authorisation-id}			200 calls per day
GET /{aspsp-cde}/v1-0-4/{payment-service}/{payment-product}/{payment-id}/cancellation-authorisations/{authorisation-id}			200 calls per day