Get self payment by Id

📘

API Refs

• Production: Get self payment by Id
• Staging: Get self payment by Id

URI parameters

Name	Type	Description	Required
paymentId	string	payment 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. Can be only of two types: ACH or paper check with delivery type.	yes
memo	string	A string with a maximum length of 280 characters.	no
createdAt	Date	Creation date	yes

Example

1. Get list of self payments Request;
2. Get list of self payments Response:
   JSON

   [
     {
       "id": 1,
       "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
       "amount": 10.23,
        "createdAt": "2023-08-09T15:42:26.683Z",
       "customerId": 1,
       "customerName": "John Smith",
       "merchantName": "Jake Merchant",
       "fee": "0.00",
       "feeDeductFrom": null,
       "status": "Awaiting-cash-out",
       "type": "--",
       "memo": ""
     },
     {
       "id": 2,
       "transactionId": "a555aa55-aaa5-5a5a-aaaa-a55a55555a55",
       "amount": 30.08,
       "createdAt": "2023-08-09T17:40:00.241Z",
       "customerId": 1,
       "customerName": "John Smith",
       "merchantName": "Jake Merchant",
       "fee": "0.00",
       "feeDeductFrom": null,
       "status": "Awaiting-cash-out",
       "type": "--",
       "memo": ""
     }
   ]
   

3. Get self payment by Id Request with id = 1;
4. Get self payment by Id Response:
   JSON

   {
     "id": 1,
     "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
     "amount": 10.23,
     "createdAt": "2023-08-09T15:42:26.683Z",
     "customerId": 1,
     "customerName": "John Smith",
     "merchantName": "Jake Merchant",
     "fee": "0.00",
     "feeDeductFrom": null,
     "status": "Awaiting-cash-out",
     "type": "--",
     "memo": ""
   }
   

Description

📘

Where to get payment id?

You can get all existing payments. Go to Get list of self payments for more information about it.

You can return information about a specific payment that you sent.
Payment Id can be used in other requests of our API in the paymentId parameter