Payment
Payment is the act of drawing cash or cash equivalent out of a financial institution such as a bank. It consists of ACH and checks.
1.1 Authentication and authorization: The API should provide authentication and authorization functions to ensure that only authorized users can access the payment and deposit features of the application.
1.2 Payment initiation: The API should allow developers to initiate payments from within their applications, providing a simple way for users to make purchases or pay bills.
1.3 Payment tracking: The API should allow developers to track the status of payments and deposits, providing real-time information about transactions.
1.4 Payment cancellation: The API should allow developers to cancel payments or deposits that have not yet been completed.
1.5 Reporting: The API should provide reporting features that allow developers to view transaction histories and generate reports for accounting and reconciliation purposes.
1.6 Fees: The API may include fees for processing ACH payments. These fees may include transaction fees, monthly fees, and other charges. Developers should carefully evaluate the pricing and fee structures of different providers to choose the most cost-effective solution for their needs.
Create Payment Transaction
Action: POST
Endpoint: /api/v2/services/money-movements/payments
Create a new payment to push funds to an external account from a managed sleeve account’s balance.
Request body
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
amount | Number | The amount to send out | 1.05 | Required |
memo | String | Additional text describing the transaction | Gift purpose | Optional |
payerId | String | Managed sleeve account Id | "B57A" | Required |
payeeId | String | Approved Vendor Id | "AR5DS" | Required |
payeeBankId | String | Vendor related banks | "A123" | Required |
scheduledDate | Date | Scheduled date of the payment | 2022-10-10 | Optional |
transferType | Enum | Type of payment transfer | "Bank_Wire" | Required |
Sample request body
{
"amount": 50,
"memo": "Gift",
"payeeBankId": "A125VC",
"payeeId": "A2135VC",
"payerId": "CA125VC",
"scheduledDate": "2022-11-08",
"transferType": "EFT"
}
Responses
Code | Status |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Responses Body
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
Sample Responses Body
{
"ownerName": null,
"vendor": null,
"checkStub": null,
"checkDate": null,
"vendorEmail": "[email protected]",
"daytimePhone": null,
"accountToAccountPayee": null,
"recordTypeId": "0128c000002aGI1AAM",
"completedDate": null,
"contactAsVendorId": null,
"ssnTaxPayerId": null,
"party": null,
"checkNumber": null,
"lastName": "Test Account 2",
"payToAccount": null,
"scheduleDate": "2022-04-07",
"name": "Payment request from client - 0038c00002jgjHAAAY",
"actualPickUpDate": null,
"bankInfoId": null,
"accountNumber": "132412433214",
"transferType": "EFT",
"memo": null,
"bankName": null,
"firstName": null,
"swiftCode": null,
"amount": 103,
"isConfirmed": false,
"createdDate": "Apr 07,2022 03:26 PM",
"sleeveAccountId": "a098c00000sy3szAAA",
"paymentType": "Immediately",
"overnightMail": false,
"destinationCountry": null,
"careOf": null,
"bankRoutingNumber": null,
"feeApplied": 35,
"accountAsVendorId": "0018c00002GzMp3AAF",
"amountType": null,
"requestedPickupDate": null,
"accountType": null,
"submitterId": "0038c00002jgjHAAAY",
"address": "123 main street",
"city": "DALLAS",
"state": "TX",
"zipCode": "75252",
"id": 8,
"acId": "a0T8c00000b3ZS0EAM",
"status": "In_Progress_1",
"step": "Process_2",
"fullBankAccountNumber": null,
"intermediaryRoutingNumber": null,
"intermediaryFinancialInstitution": null,
"achBatchId": null
}
Retrieve the Payer List
1.1 Use /api/v2/services/money-movements/payments/payers to retrieve the payer list for the payment.
Action: GET
Endpoint: /api/v2/services/money-movements/payments/payers
Retrieve the payer list for the payment.
Request Parameters
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
page | int32 | Page of the payer list, | 123 | Optional |
size | int32 | Size of the payer list | 567777 | Optional |
sort | array of strings | Optional |
Responses
Code | Status |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Responses
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
Sample Responses Body
Retrieve the Payee List
Use /api/v2/services/money-movements/payments/payees to retrieve the payee list for the payment.
Action: GET
Endpoint: /api/v2/services/money-movements/payments/payees
Retrieve the payee list for the payment.
Request Parameters
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
page | int32 | Page of the payer list, | 123 | Optional |
size | int32 | Size of the payer list | 567777 | Optional |
sort | array of strings | Optional |
Responses
Code | Status |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Responses Body
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
Sample Responses Body
Retrieve the Payee Bank List
Use /api/v2/services/money-movements/payments/payees/{payeeId}/banks to retrieve the payee bank list for the payment.
Action: GET
Endpoint: /api/v2/services/money-movements/payments/payees/{payeeId}/banks
Retrieve the list of banks of the payee.
URL Path Parameters
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
payeeId | String | Approved Vendor ID | "AR5DS" | Required |
Responses
Code | Status |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Responses Body
Fields | Data Type | Description |
---|---|---|
payeeId | String | Approved Vendor ID Send a GET request to /payments/payees to retrieve the approved vendor ID. |
Sample Responses Body
Request Parameters
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
page | int32 | Page of the payer list, | 123 | Optional |
size | int32 | Size of the payer list | 567777 | Optional |
sort | array of strings | Optional |
Responses Body
Fields | Data Type | Description | Sample | Required or Not |
---|---|---|---|---|
Sample Responses Body
Updated 10 months ago