To initiate a standard payment, you should call the Initiate Payment API.
Tip! Make sure your Access token has ob-ps and ob-ps:authz-nosca scopes.
Note! Some initiated payments in Stage and Production environments might be stopped by transaction monitoring rules.
Parameters and their descriptions are mentioned below.
| Parameter | Description |
|---|---|
| paymentRail | Payment network infrastructure, using which money transfer is executed. ConnectPay supports the following payment rails: Internal – between two ConnectPay accounts; SEPA SCT Ins – SEPA Instant Credit Transfer; SEPA SCT – SEPA Credit Transfer; SWIFT – cross border transfer |
| debtorAccount.iban | Payer account |
| ultimateDebtor.name | Ultimate payer name |
| ultimateDebtor.dateOfBirth | Ultimate payer date of birth |
| ultimateCreditor.name | Ultimate beneficiary name |
| ultimateCreditor.address.countryCode | Ultimate beneficiary country code |
| ultimateCreditor.financialInstitution.name | Ultimate beneficiary financial institution name |
| ultimateCreditor.financialInstitution.bic | Ultimate beneficiary bank code |
| creditorAccount.iban | Beneficiary account |
| creditorAccount.bic | Beneficiary bank code |
| creditorAccount.bankBranchCode | Beneficiary bank branch code |
| creditorAccount.bankName | Beneficiary bank name |
| creditorName | Beneficiary name |
| instructedAmount.amount | Precise instructed amount value. For example: 9.00 |
| instructedAmount.currency | Instructed currency Available currencies: EUR, USD, CAD, JPY, PLN, GBP, CZK, CHF, AUD, SEK, DKK, NOK, HUF, RON, SGD, HKD |
| creditorAddress.addressLine1 | Beneficiary address |
| creditorAddress.city | Beneficiary city |
| creditorAddress.postcode | Beneficiary post code |
| creditorAddress.state | Beneficiary state |
| creditorAddress.countryCode | Beneficiary country code using ISO 3166-1 standard |
| remittanceInformationUnstructured | Payment details |
| remittanceInformationStructured.reference | Payment details |
| externalReference | Payment reference number provided by the customer |
Tip! As mentioned in Payment rails section, “paymentRail” is optional field. If not filled in, then payment rail will be calculated automatically and fastest payment rail will be chosen by ConnectPay when Initiate Payment API is called.
For Financial Institutions, when making payments on behalf of their clients, it is mandatory to provide the full name of the Ultimate Debtor. Use the “ultimateDebtor.name” property. Please do not use the “ultimateDebtor.name” property if it’s not applicable in your case.
Response body of the Initiate Payment API will return “paymentOrderNo”, “paymentRail”, “transactionStatus” and “transactionFees”.
{n u0022paymentOrderNou0022: u0022s-63094981950428443476u0022,n u0022paymentRailu0022: u0022SEPA_SCTu0022,n u0022transactionStatusu0022: u0022RCVDu0022,n u0022transactionFeeIndicatoru0022: true,n u0022transactionFeesu0022: {n u0022amountu0022: u00225.00u0022,n u0022currencyu0022: u0022EURu0022n }