CardSwap APIAppearance
The Payment Method Object
The payment method which can be a card or bank payment type.
| Attribute | Description |
|---|---|
_id | ID of the payment method. |
type | The type of the payment method on file. Possible values are card, bank. |
identifier | Optional - custom identifier for external system correlation. |
status | The status of the payment method on file. Possible values are verified, declined. |
default | If this is the default payment method. Default means that it will pay any bills not specifically assigned a payment method. |
assignedBills | A list of bill ID's this payment method was specifically assigned to. |
card | Card object |
bank | Bank object |
Card Object
| Attribute | Description |
|---|---|
number | Masked card number. |
brand | Card brand. Possible values are visa, mastercard, american express, etc. |
type | Card type. Possible values are credit, debit. |
expDate | Card expiration date. |
Example Card Response
json
{
"_id": "580e3e11dec21e861b5a3719",
"type": "card",
"identifier": "optional_custom_identifier",
"status": "verified",
"default": true,
"card": {
"number": "XXXX0005",
"brand": "american express",
"type": "credit",
"expDate": "2019-06-01T12:00:00.000Z"
},
"assignedBills": []
}Bank Object
| Attribute | Description |
|---|---|
routingNumber | Masked routing number. |
accountNumber | Masked account number. |
type | Bank account type. Possible values are checking, savings. |
Example Bank Response
json
{
"_id": "580e3e11dec21e861b5a3719",
"type": "card",
"identifier": "optional_custom_identifier",
"status": "verified",
"default": true,
"bank": {
"routingNumber": "XXXX0002",
"accountNumber": "XXXX0021",
"type": "checking"
},
"assignedBills": []
}Status
A payment method status.
verified
The payment method on file is verified and eligible to make payments.