Open Banking API
Retrieve a draft payment

Retrieve a draft payment

Get the details about a specific draft payment with the given draft payment ID.

See also Tutorials: Create your first draft payment and Tutorials: Work with draft payments.


Each Open Banking API must contain an authorization header in the following format to make a call: Bearer <yourAccessToken>.

Before you start, ensure that you've got an access token with the correct scope using the /token endpoint. You need to get the authorization code first and exchange it for an access token.


Never share your access_token with anyone, as it can be used to access the banking data that you have access to and initiate transactions.

For more information, see Tutorial: Get account and transaction information and Tutorial: Initiate your first payment as examples.


Open Banking API Payment requests additionally require a JSON Web Signature (JWS) which needs to be added to the header of the request. The JWS signature must be obtained using the full content of the payload.


Path Parameters
Path Parameters

The ID of the draft payment.


Draft Payment Details

Response body
Body object

The ID of the draft payment.

The execution date the draft payment is requested.

Possible values: [Awaiting, Processed, Approved, Deleted]

The status of the draft payment.

The ID of the transfer.

Possible values: Value must match regular expression ^\d{1,13}\.\d{1,5}$

The amount of money.

Possible values: Value must match regular expression ^[A-Z]{3}$

ISO 4217 currency code in upper case.

The reference of the draft payment.

Possible values: [Created, Pending, Completed, Failed, Deleted]

The status of the draft payment.

The row number the draft payment represents in the CSV file.

The reason of the failed draft payment.

The reason code for the failed draft payment.

Was this page helpful?