| Field Name | Required | Field Specs (Data Type + Field Length) | Description |
|---|---|---|---|
| businessId | Required | String (20) | Static business id of Client, this can be dynamic for future use cases |
| internalId | Required | String (20) | Internal ID would be the internal id of the customer or vendor. Internal ID refers to the unique identifier assigned to either the customer whose invoice is due or the vendor whose bill needs to be paid |
| Type | Required | JSON Object (collection, deposit) | The transaction type should be specified based on its purpose. If the transaction involves collecting payment for an invoice from a customer, the type should be set to 'Collection'. If it involves making a payment for a bill to a vendor, the type should be set to 'Deposit' |
| paymentMethod | Required | JSON Object (ach, card, rapidpay, check, paymentMethodId) | If type is “Collection” then the paymentMethod can be ACH or Card. If type is “Deposit” the paymentMethod can be ACH or Rapid Pay or Check. |
| accountNumber | Required, if paymentMethod is ACH | String (20) | The bank account number associated with the ACH payment. |
| routingNumber | Required, if paymentMethod is ACH | String (20) | The routing number of the bank associated with the ACH payment. |
| accountName | Required, if paymentMethod is ACH | String (100) | The name of the account holder as it appears on the bank account. |
| accountType | Required, if paymentMethod is ACH | String (40) | The name type of the account. It can be Business/Personal – Checking/Personal – Savings) |
| cardNumber | Required, if paymentMode is Rapid Pay | String (16) | The card number of Fintainium Rapid Pay card, typically a string of 16 digits. |
| monthYear | Required, if paymentMode is Rapid Pay | Date MM/YY | The expiration date of the card Fintainium Rapid Pay, in the format MM/YY |
| cvv | Optional | String (3) | The card verification value, a security needed to set during creation of Fintainium Rapid Pay card or AR Credit card. Typically, a string of 3 digits. |
| nameOnCard | Required, if paymentMode is Rapid Pay | String (100) | The name of the cardholder as it should on the Fintainium Rapid Pay card. |
| zipCode | Required | String (20) | Postal code of the account / card |
| printName | Required, if paymentMode is Check | String (100) | Name of the individual or entity to whom a check is made payable |
curl --location 'https://staginggateway.fintainium.com/gateway/payment/paymentMethod' \
--header 'sessionKey: z4FEVD7d2SVGG0B8QF1rXUTMqzUDncOT' \
--header 'Content-Type: application/json' \
--data '{
"businessId": "34567890",
"internalId": "1235678",
"type": {
"collection": {
"paymentMethod": {
"card": {
"cardNumber": "1234898567786754",
"monthYear": "12/25",
"cvv": "123",
"nameOnCard": "John Doe",
"zipCode": "56789"
},
"ach": {
"accountNumber": "123456789",
"routingNumber": "987654321",
"accountName": "John Doe",
"accountType": "Business"
}
}
},
"deposit": {
"paymentMethod": {
"rapidPay": {
"cardNumber": "1234567812345678",
"monthYear": "12/25",
"cvv": "123",
"nameOnCard": "John Doe"
},
"ach": {
"accountNumber": "123456789",
"routingNumber": "987654321",
"accountName": "John Doe",
"accountType": "Business"
},
"check": {
"printName": "John Doe"
}
}
}
}
}'{
"statusCode": 200,
"actionCode": "00",
"message": "Payment method saved successfully",
"failedCount": 0,
"failedMessageList": [],
"successCount": 1,
"type": "collection",
"businessId": "4305551",
"internalId": "123456",
"paymentMethodId": 347,
"name": "",
"accountName": "",
"nameOnCard": "John Doe",
"printName": "",
"status": true,
"isTempCard": false,
"isDefault": false,
"archive": false,
"transmissionDateTime": "2024-12-17 12:35:49"
}