Regionalized Solutions
R24 AMR | Min(s) read
Generic API's
Please find below the API details for the EFT Interface module.
The API will only be useable if the module has been licenced by the client.
| API Name | Description | Domain | Method | URL | Resource | Operation Id | End Point Description |
|---|---|---|---|---|---|---|---|
| order-ca-Payment-service | Canadian region APIs to create, update and retrieve external payments, payment orders and recurring order instructions for payments | order | POST | /order/ca/standingOrders/{standingOrderID}/externalAccounts | CAPL.H.PAP.DD.DDI,CAEFPA.API.GENERIC.1.0.0 | createCaStandingOrderExternalAccounts | Create standing order for the external accounts with the details such as date, currency, settlement instruction, amount, status etc. Debit or credit beneficiary should be an external party. |
| order | PUT | /order/ca/standingOrders/{standingOrderID}/externalAccounts | CAPL.H.PAP.DD.DDI,CAEFPA.API.GENERIC.1.0.0 | updateCaStandingOrderExternalAccounts | Update standing order for the external accounts with the details such as date, currency, settlement instruction, amount, status etc. Debit or credit beneficiary should be an external party. | ||
| order | GET | /order/ca/standingOrders/externalAccounts | CAEFPA.API.PAP.DDI.DETAILS.1.0.0 | getCaStandingOrderExternalAccounts | Retrieve standing order for the external accounts such as date, currency, settlement instruction, amount, status etc. | ||
| order | POST | /order/ca/payments/instructions/{instructionId}/standingOrders | CAEFPA.RECURRING.PAYMENT.DETAILS,CAEFPA.API.SET.1.0.0 | createCaRecurringPaymentInstruction | Create recurring payments instructions with details such as customer, settlement account number, frequency, amount, start date, end date, etc. Details in the Transact is defined for information & not accounting | ||
| order | PUT | /order/ca/payments/instructions/{instructionId}/standingOrders | CAEFPA.RECURRING.PAYMENT.DETAILS,CAEFPA.API.SET.1.0.0 | updateCaRecurringPaymentInstruction | Update recurring payments instructions with details such as next payment date, retry count , status etc | ||
| order | GET | /order/ca/payments/instructions/standingOrders | CAEFPA.API.RECURRING.PAYMENTS.1.0.0 | getCaRecurringPaymentInstruction | Retrieves the recurring payments instructions with details such as customer, account number, settlement account, next payment date, retry count , status etc based on instruction id, originator reference, template id and booking date. Any one selection is mandatory. | ||
| order | POST | /order/ca/paymentOrders/ | PAYMENT.ORDER,CAEFPA.API.CREATE.1.0.0 | createCaPaymentOrder | Create payments order for both EFT (Electronic Funds Transfer) and CQ (Clearing Cheque) payments | ||
| party-ca-payment-service | Canadian region APIs to create, update and retrieve external payments, payment orders and recurring order instructions for payments | party | POST | /party/ca/beneficiaries | BENEFICIARY,CAEFPA.API.GENERIC.1.0.0 | createCaBeneficiaries | Creates beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing |
| party | PUT | /party/ca/beneficiaries/{beneficiaryId} | BENEFICIARY,CAEFPA.API.GENERIC.1.0.0 | updateCaBeneficiaries | Update beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for payment processing | ||
| party | GET | /party/ca/customers/{customerId}/externalAccounts | CAEFPA.API.EXTERNAL.ACCT.DETAILS.1.0.0 | getCaCustomerExternalAccounts | Retrieve the beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for intermember setup based on customer id | ||
| party | GET | /party/ca/cards/{cardId}/externalAccounts | CAEFPA.API.EXTERNAL.ACCT.DETAILS.1.0.0 | getCaCardExternalAccounts | Retrieve the beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for intermember setup based on card id |
In this topic