Payment

Retrieves the collection of Payment resources for a given business registry.

IMPORTANT NOTE - If the createdAt filter is not explicitly set, this API will return only payments made during the current month. Here is an example of the createdAt filter. createdAt[after]=2022-01-20

SecurityBearer
Request
path Parameters
fiscalId
required
string
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

account.uuid
string
account.uuid[]
Array of strings
system
string
system[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
Responses
200

Payment collection

get/business-registry/{fiscalId}/payments
Request samples 
Response samples 
[
  • {
    }
]
Starts process for receiving a SEPA payment on a certain account
This API starts the process for receiving a payment on a certain account through SEPA circuit.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new Payment resource


amount
required
string^([-+]?[0-9]*\.?[0-9]+)$
 
currencyCode
required
string
A three letter currency code. At the moment only EUR is supported


 Value: "EUR"  
http://schema.org/priceCurrency
description
required
string^(.{1,1000})$
A description at most 1000 chars long


 
accountUuid
required
email
string or null <email> 
Optional e-mail of the debtor. If present, it will receive the request-to-pay link


 
http://schema.org/email
returnUrl
string or null <uri> 
Optional URL for the customer to return to after a payment


 
http://schema.org/url
Responses 
201
Payment resource created


400
Invalid input


422
Unprocessable entity


post/payments/receive/sepa
Request samples 
application/json
{
  • "amount": "1234.56",
  • "currencyCode": "EUR",
  • "description": "Some description",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "email": "someone@mail.test",
  • "returnUrl": "http://example.com"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "connectUrl": "string"
}
Starts process for receiving a SEPA INSTANT payment on a certain account
This API starts the process for receiving a payment on a certain account through SEPA INSTANT circuit. The maximum amount that can be received is one hundred thousand Euro.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new Payment resource


amount
required
string^([-+]?[0-9]*\.?[0-9]+)$
The amount of the payment. Maximum value is one hundred thousand Euro


 
currencyCode
required
string
A three letter currency code. At the moment only EUR is supported


 Value: "EUR"  
http://schema.org/priceCurrency
description
required
string^(.{1,1000})$
A description at most 1000 chars long


 
accountUuid
required
email
string or null <email> 
Optional e-mail of the debtor. If present, it will receive the request-to-pay link


 
http://schema.org/email
returnUrl
string or null <uri> 
Optional URL for the customer to return to after a payment


 
http://schema.org/url
Responses 
201
Payment resource created


400
Invalid input


422
Unprocessable entity


post/payments/receive/sepa-instant
Request samples 
application/json
{
  • "amount": "1234.56",
  • "currencyCode": "EUR",
  • "description": "Some description",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "email": "someone@mail.test",
  • "returnUrl": "http://example.com"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "connectUrl": "string"
}
Starts process for sending a SEPA payment from a certain account
This API starts the process for sending a payment from a certain account through SEPA circuit.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new Payment resource


amount
required
string^([-+]?[0-9]*\.?[0-9]+)$
 
currencyCode
required
description
required
string^(.{1,1000})$
 
accountUuid
required
creditorIban
required
creditorName
required
string or null
 
returnUrl
string or null <uri> 
Optional URL for the customer to return to after a payment


 
http://schema.org/url
Responses 
201
Payment resource created


400
Invalid input


422
Unprocessable entity


post/payments/send/sepa
Request samples 
application/json
{
  • "amount": "string",
  • "currencyCode": "EUR",
  • "description": "string",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "creditorIban": "string",
  • "creditorName": "string",
  • "returnUrl": "http://example.com"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "connectUrl": "string"
}
Starts process for sending a SEPA INSTANT payment from a certain account
This API starts the process for sending a payment from a certain account through SEPA INSTANT circuit.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new Payment resource


amount
required
string^([-+]?[0-9]*\.?[0-9]+)$
 
currencyCode
required
description
required
string^(.{1,1000})$
 
accountUuid
required
creditorIban
required
creditorName
required
string or null
 
returnUrl
string or null <uri> 
Optional URL for the customer to return to after a payment


 
http://schema.org/url
Responses 
201
Payment resource created


400
Invalid input


422
Unprocessable entity


post/payments/send/sepa-instant
Request samples 
application/json
{
  • "amount": "string",
  • "currencyCode": "EUR",
  • "description": "string",
  • "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  • "creditorIban": "string",
  • "creditorName": "string",
  • "returnUrl": "http://example.com"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "connectUrl": "string"
}
Retrieves a Payment resource.
Retrieves a Payment resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string <uuid> 
 
Responses 
200
Payment resource


404
Resource not found


get/payments/{uuid}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "direction": "inbound",
  • "status": "string",
  • "system": "sepa",
  • "amount": "1234.56",
  • "currencyCode": "EUR",
  • "description": "string",
  • "endToEndId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "debtorProviderName": "string",
  • "account": {
    },
  • "extra": {
    },
  • "transaction": {
    }
}