Create a payment instruction

post

https://api.sandbox.tapico.io/v1/payment-instructions

Create a payment instruction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The payment instruction to create.

accountServicerId

uuid

Unique identifier for Account Servicer.

applicationId

uuid

Unique identifier for Application.

callbackUri

string

Source system URI to send the end customer to upon completing the process.

endToEndIdentification

string

required

length between 1 and 18

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

amount

number

required

Payment amount

currency

string

required

Payment currency in ISO 4217 format

executionDate

date

Date when payment should be executed. When omitted, defaults to today.

externalCustomerId

string

Your unique customer identification.

debtorAccount

object

creditorAccount

object

required

paymentMethod

string

enum

remitterReference

string

length between 1 and 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

remittanceInformation

string

length between 1 and 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

riskInformation

object

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

Headers

region

string

enum

Specifies the Region for the request. When specified, this must match the region that the application access token was generated for.

For more information about regions see https://docs.tapico.io/docs/regions

Allowed:

x-idempotency-key

string

required

Supports idempotency for safely retrying requests without accidentally performing the same operation twice.

If the header is not included, the request will fail with a 400 response code.

Responses

Language

Credentials

Bearer

jwt

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201success response.

400Bad Request.

401The credentials used are not recognised.

403Forbidden.

409This request is already in progress please try again later.

422Request parameter validation error.

429Too many requests sent in quick succession.

500Internal Server Error.