Accept pending payment as RTP payment
API Refs
- Production: Accept pending payment as RTP payment
- Staging: Accept pending payment as RTP payment
URI Parameters
Name | Type | Description | Required | |
---|---|---|---|---|
paymentId | string | Pending payment id | yes |
Request body
Name | Type | Description | Required |
---|---|---|---|
bankId | string | Insuredās bank id | yes |
Response body
Name | Type | Description | Required |
---|---|---|---|
id | number | Id of payment. Can be used for any payment operations. | yes |
transactionId | string | Payment transaction Id. It can be seen in the application in the transaction history. | yes |
amount | number | Payment amount without any fees. | yes |
customerId | number | The Id of the insured who will receive the payment or has already received it. | yes |
customerName | string | Name of the insured who will receive the payment or has already received it. | yes |
merchantName | string | Name of the insurer who will send the payment or has already sent it. | yes |
fee | number | Fee for the payment amount. It will only be different from zero when this payment is sent. | yes |
feeDeductFrom | string | Which side of the transfer will pay the fee. | yes |
status | string | Status of payment. Main statuses: Awaiting-cash-out, Canceled, Preparing to mail, In-transit, Settled | yes |
type | string | Type of payment. | yes |
memo | string | A string with a maximum length of 280 characters. | no |
createdAt | Date | Creation date | yes |
Example
- Get list of insuredās banks Request with userId = 1:
- Get list of insuredās banks Response:
[ { "id": "11a111a1-1111-1111-11a1-11a1a1aa11aa", "name": "Bank_995", "accountType": "checking", "type": "bank", "status": "unverified" }, { "id": "22a222a1-2222-2222-22a2-22a2a2aa22aa", "name": "Bank_996", "accountType": "savings", "type": "bank", "status": "unverified" } ]
- Get list of self payments Request;
- Get list of self payments Response:
[ { "id": 1, "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44", "amount": 10.23, "createdAt": "2023-08-09T15:42:26.683Z", "customerId": 2, "customerName": "John Smith", "merchantName": "Jake Merchant", "fee": "0.00", "feeDeductFrom": null, "status": "Awaiting-cash-out", "type": "--", "memo": "" } ]
- Accept pending payment as RTP payment Request with paymentId = 1:
{ "bankId": "11a111a1-1111-1111-11a1-11a1a1aa11aa" }
- Accept pending payment as RTP payment Response:
{ "id": 1, "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44", "amount": 10.23, "createdAt": "2023-08-09T15:42:26.683Z", "customerId": 2, "customerName": "John Smith", "merchantName": "Jake Merchant", "fee": "0.79", "feeDeductFrom": "recipient", "status": "In-transit", "type": "RTP", "memo": "" }
Description
Where do I get my insured's bank id?
You can get a list of all existing banks for any of your insureds. Go to Get list of insuredās banks for more information about it.
When accepting a pending payment as an RTP transaction (Instant), you must always indicate the bank Id that you intend to use on the insured's side. This bank must be able to receive RTP transactions (the majority of banks in the US support Real Time Payments, but not all).
When a transaction is created, the payment status will initially change to the LOCK
.
If the transaction is successfully created, the pending payment status will change to In-transit
.
Such a payment has the following statuses:
In-transit
- transaction in progress;Settled
- transaction completed successfully;Failed
- the transaction did not complete successfully;Canceled
- the transaction has been canceled.
This functionality must be enabled for your account upon request. Reach out to our customer success team at [email protected] if you'd like to enable RTP payments
Updated 3 months ago