Accept pending payment as RTP payment

📘

API Refs

URI Parameters

NameTypeDescriptionRequired
paymentIdstringPending payment idyes

Request body

NameTypeDescriptionRequired
bankIdstringInsured’s bank idyes

Response body

NameTypeDescriptionRequired
idnumberId of payment. Can be used for any payment operations.yes
transactionIdstringPayment transaction Id. It can be seen in the application in the transaction history.yes
amountnumberPayment amount without any fees.yes
customerIdnumberThe Id of the insured who will receive the payment or has already received it.yes
customerNamestringName of the insured who will receive the payment or has already received it.yes
merchantNamestringName of the insurer who will send the payment or has already sent it.yes
feenumberFee for the payment amount. It will only be different from zero when this payment is sent.yes
feeDeductFromstringWhich side of the transfer will pay the fee.yes
statusstringStatus of payment. Main statuses: Awaiting-cash-out, Canceled, Preparing to mail, In-transit, Settledyes
typestringType of payment.yes
memostringA string with a maximum length of 280 characters.no
createdAtDateCreation dateyes

Example

  1. Get list of insured’s banks Request with userId = 1:
  2. 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"
      }
    ]
    
  3. Get list of self payments Request;
  4. 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": ""
      }
    ]
    
  5. Accept pending payment as RTP payment Request with paymentId = 1:
    {
      "bankId": "11a111a1-1111-1111-11a1-11a1a1aa11aa"
    }
    
  6. 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