Skip to main content
curl --request POST \
  --url https://api.yapily.com/payments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --header 'consent: <consent>' \
  --data '
{
  "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
  "payer": {
    "name": "John Doe",
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "DE12345678901234567890"
      }
    ]
  },
  "amount": {
    "amount": 1,
    "currency": "EUR"
  },
  "reference": "Bill Payment",
  "type": "DOMESTIC_PAYMENT",
  "payee": {
    "name": "Jane Doe",
    "address": {
      "country": "BE"
    },
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "BE12345678901234"
      }
    ]
  }
}
'
{
  "meta": {
    "tracingId": "0f14e900011b445fa6b6c2c4272d7321"
  },
  "data": {
    "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d",
    "status": "COMPLETED",
    "statusDetails": {
      "status": "COMPLETED",
      "isoStatus": {
        "code": "ACCP",
        "name": "AcceptedCustomerProfile"
      }
    },
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "IBAN",
          "identification": "DE12345678901234567890"
        }
      ]
    },
    "payeeDetails": {
      "name": "Jane Doe",
      "accountIdentifications": [
        {
          "type": "IBAN",
          "identification": "BE12345678901234"
        }
      ]
    },
    "reference": "Bill Payment",
    "amount": 1,
    "currency": "EUR",
    "amountDetails": {
      "amount": 1,
      "currency": "EUR"
    }
  }
}
Learn more: Payment Types - This endpoint supports 7 payment types (single, periodic, scheduled, international)

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
consent
string
required

Mandatory. The consent-token containing the user's authorisation to make the request.

​
psu-id
string

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

​
psu-corporate-id
string

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

​
psu-ip-address
string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

​
sub-application
string<uuid>

The sub-application ID to which event type is being subscribed to

Body

application/json;charset=UTF-8

Mandatory. The payment request object defining the details of the payment.

​
paymentIdempotencyId
string
required

Mandatory. A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.

Example:

"04ab4536gaerfc0e1f93c4f4"

​
type
enum<string>
required

Mandatory. Used to specify which of the payment types to execute.

See European Payments to verify whether the type should be DOMESTIC or INTERNATIONAL.

Available options:
DOMESTIC_PAYMENT,
DOMESTIC_INSTANT_PAYMENT,
DOMESTIC_VARIABLE_RECURRING_PAYMENT,
DOMESTIC_SCHEDULED_PAYMENT,
DOMESTIC_PERIODIC_PAYMENT,
INTERNATIONAL_PAYMENT,
INTERNATIONAL_SCHEDULED_PAYMENT,
INTERNATIONAL_PERIODIC_PAYMENT,
BULK_PAYMENT
​
payee
Payee Details · object
required

Mandatory. Details of the beneficiary [person or business].

​
amount
Amount Details · object
required

Mandatory. Monetary Amount.

​
payer
Payer Details · object

Conditional. Details of the benefactor [person or business].

​
reference
string

Optional. The payment reference or description. Limited to a maximum of 18 characters long.

Example:

"Bill payment"

​
contextType
enum<string>
default:OTHER

Optional. The payment context code. This defaults to OTHER if not specified.

Available options:
BILL,
GOODS,
SERVICES,
OTHER,
PERSON_TO_PERSON,
BILL_IN_ADVANCE,
BILL_IN_ARREARS,
ECOMMERCE_MERCHANT,
FACE_TO_FACE_POS,
TRANSFER_TO_SELF,
TRANSFER_TO_THIRD_PARTY,
PISP_PAYEE
​
purposeCode
string

Optional. The payment purpose code.

Allowed values: INTP, DEPT, BEXP, LICF, SERV, SUPP, TRAD, SUBS, GDSV, ROYA, COMT, CHAR, ECPR, CLPR, INTE, LOAN, LOAR, INPC, INPR, INSC, INSU, LIFI, PPTI, HLRP, HLST, PDEP, IVPT, REBT, REFU, CDBL, CPKC, EDUC, FEES, GAMB, LOTT, GIFT, INSM, REOD, GOVT, TCSC, BLDM, RENT, DIVD, INVS, SAVG, HLTI, DNTS, LTCF, MDCS, VIEW, BECH, BENE, SSBE, PEFC, PENS, ADCS, BONU, COMM, SALA, ESTX, HSTX, INTX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, CBTV, ELEC, GASB, PHON, UBIL, WTER .

See Payment Purpose code to see the definition of each code

​
periodicPayment
object

Conditional. Used to specify properties to define a periodic payment.

Must be specified when the payment type is one of the following:

  • DOMESTIC_PERIODIC_PAYMENT
  • INTERNATIONAL_PERIODIC_PAYMENT
​
internationalPayment
object

Conditional. Used to specify properties to define an international payment.

Must be specified when the payment type is one of the following:

  • INTERNATIONAL_SINGLE_PAYMENT
  • INTERNATIONAL_SCHEDULED_PAYMENT
  • INTERNATIONAL_PERIODIC_PAYMENT
​
paymentDateTime
string<date-time>

Conditional. Used to specify the date of the payment when the payment type is one of the following:

  • DOMESTIC_SCHEDULED_PAYMENT
  • DOMESTIC_PERIODIC_PAYMENT
  • INTERNATIONAL_SCHEDULED_PAYMENT
  • INTERNATIONAL_PERIODIC_PAYMENT
Example:

"2021-07-21T17:32:28Z"

​
readRefundAccount
boolean

Optional. Used to request the payer details in the payment response when the Institution provides the feature READ_DOMESTIC_SINGLE_REFUND.

See Reverse Payments for more information.

Example:

false

Response

Created

​
meta
object
​
data
object
​
links
object
​
forwardedData
object[]
​
raw
object[]
deprecated