Retrieves all of the payment methods and wallet balances for the specified account ID.
The capabilities
object defines how payment methods may be used. A payment method ID in the purchase capability array means that it may be used to pay for invoices. Some payment methods can be used in multiple ways and therefore appear in multiple capability arrays. The IDs in the capability arrays are keys into the response payment_methods
object, which provides more detail on a given payment method.
The balances
object returns the state of this user's Tilia wallet balances. Virtual currencies return 1) spendable balance, which denotes the total balance the user may spend, and 2) convertible balance, which is the virtual balance that the user may convert to fiat through token conversion. Spendable balance is the sum of convertible and non-convertible balances. In the case of fiat currencies, only spendable balances are returned.
Transaction Methods Response
Invalid input
Unauthorized access.
Resource not found.
Service unavailable or server error.
{- "payload": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "balances": {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "balances": {
- "property1": {
- "spendable_balance": {
- "balance": "50000",
- "display": "$500.00"
}, - "spendable": {
- "balance": "20000",
- "display": "$200.00"
}, - "convertible": {
- "balance": "10000",
- "display": "$100.00"
}
}, - "property2": {
- "spendable_balance": {
- "balance": "50000",
- "display": "$500.00"
}, - "spendable": {
- "balance": "20000",
- "display": "$200.00"
}, - "convertible": {
- "balance": "10000",
- "display": "$100.00"
}
}
}
}, - "capabilities": {
- "purchase": "['<payment_method_id1>','<payment_method_id2>','<payment_method_id3>']",
- "payout": "['<payment_method_id2>']",
- "deposit": "[ ]"
}, - "payment_methods": {
- "<payment_method_id1>": {
- "id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "method_class": "american-express",
- "display_string": "American Express ending in 0002",
- "provider": "rebilly",
- "psp_reference": "8415980438197366",
- "psp_hash_code": "SD7F6S7D6F7SD6F7SD6F7SD6F7SD6F...",
- "processing_currency": "USD",
- "pm_state": "ACTIVE",
- "integrator": "acme",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "tags": [
- {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
]
}, - "<payment_method_id2>": {
- "id": "pm_2V2bA0r2hJpUnCA9HeTgOl0rONr",
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "method_class": "paypal",
- "display_string": "Paypal Account user@example.com",
- "provider": "paypal",
- "psp_reference": "8415980438197366",
- "processing_currency": "USD",
- "pm_state": "ACTIVE",
- "integrator": "acme",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "tags": [
- {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
], - "psp_provided_email": "string",
- "email_id": "string",
- "address_verified": 0
}, - "<payment_method_id3>": {
- "id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "method_class": "wallet",
- "display_string": "USD Wallet",
- "provider": "wallet",
- "psp_reference": "400e4c4b-4910-49fb-821c-8a82d93eef85",
- "processing_currency": "USD",
- "pm_state": "ACTIVE",
- "integrator": "acme",
- "created": "2019-08-24T14:15:22Z",
- "updated": "2019-08-24T14:15:22Z",
- "provider_data": {
- "wallet_id": "wal_2V2cKKqYoaj018K0EXBauwcurbd",
- "wallet_balance": 0
}, - "tags": [
- {
- "account_id": "acct_2TiDFXHVFMlAuyy7ovvz3YPKv9b",
- "created": "2019-08-24T14:15:22Z",
- "integrator": "acme",
- "namespace": "payment_method",
- "resource_id": "0e3037fd-9fbc-499b-b5e5-19948502cbdb",
- "resource_type": "payments.payment_method.id",
- "status": "ACTIVE",
- "tag": "default_payment",
- "tag_id": "paytag_1yVYRU5t1HFfsM6T6mAab4onHZp",
- "updated": "2019-08-24T14:15:22Z"
}
]
}
}
}, - "codes": null,
- "message": null,
- "status": "Success"
}