API Developer Portal

ACHPaymentAPI_fr

Swagger

ACHPaymentAPI will act as a API routing the ACH payment requests Product Systems for execution. The ACHPaymentAPI generic API exposes fours functionalities of receiving sendPayment - ISO PAIN 001(Credit) and PAIN 008 (Debit) and PaymentStatus Enquiry ( CAMT005 ) and obtain service agreement list. The subsequent validation and processing of Payment messages received, would be performed by the downstream APIs

Endpoints Summary

post

/tpp/ach/payment-initiation/customer-credit-transfer-initiation

Envoyer des paiements

post

/tpp/ach/payment-initiation/customer-direct-debit-initiation

Percevoir des paiements

post

/tpp/ach/payment-initiation/get-transaction-status/get

Obtenir l’état du paiement

TppACHExternalGenApi-SendPaymentCredit

TppACHExternalGenApi-SendPaymentCredit - receive PAIN001 (Credit) ISO JSON request as input and return PAIN002 ISO JSON as response after interacting with downstream Payment Rail System. Allowed bian scope is 'bmo.tpp.payment-initiation.create'

Post

/tpp/ach/payment-initiation/customer-credit-transfer-initiation

Try It

Request

Code Samples

Headers

x-fapi-interaction-id required

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-customer-user-agent

string

x-fapi-financial-id

string

x-crypto-key

string

x-request-id required

string

x-sourcesystem-id

string

x-api-key

string

x-app-cat-id

string

x-csrf-token

string

x-content-type

string

x-expires

string

x-cache-control

string

x-content-disposition

string

Body

Response

Table JSON

ResponsePayload { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

TppACHExternalGenApi-SendPaymentDebit

TppACHExternalGenApi-SendPaymentDebit - send Payments. receive PAIN008 (Debit) ISO JSON request as input and return PAIN002 ISO JSON as response after interacting with downstream Payment Rail System. Allowed bian scope is 'bmo.tpp.payment-initiation.create'

Post

/tpp/ach/payment-initiation/customer-direct-debit-initiation

Try It

Request

Code Samples

Headers

x-fapi-interaction-id required

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-customer-user-agent

string

x-fapi-financial-id

string

x-crypto-key

string

x-request-id required

string

x-sourcesystem-id

string

x-api-key

string

x-app-cat-id

string

x-csrf-token

string

x-content-type

string

x-expires

string

x-cache-control

string

x-content-disposition

string

Body

Response

Table JSON

ResponsePayload { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

TppACHExternalGenApi-ObtainPaymentStatus

TppACHExternalGenApi-ObtainPaymentStatus enquiry sends CAMT005 ISO JSON Request standard messages and enquires and responds back with PAIN002 ISO JSON message structure after querying matching backend. Allowed bian scope is 'bmo.tpp.payment-initiation.read'

Post

/tpp/ach/payment-initiation/get-transaction-status/get

Try It

Request

Code Samples

Headers

x-fapi-interaction-id required

string

x-fapi-customer-last-logged-time

string

x-fapi-customer-ip-address

string

x-fapi-customer-user-agent

string

x-fapi-financial-id

string

x-crypto-key

string

x-request-id required

string

x-sourcesystem-id

string

x-api-key

string

x-app-cat-id

string

x-csrf-token

string

x-content-type

string

x-expires

string

x-cache-control

string

x-content-disposition

string

Body

Response

Table JSON

ResponsePayload { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

Problem { . . .}

}

FAQs

More FAQs