Note:
The field will be disregarded if it is marked as optional and the format provided is incorrect. However, a validation error will be displayed if the field is marked as mandatory and the format provided is incorrect.
"+" - means required (for all flows)
"-" - means not required (for any flow)
For instance, in POST Create Charge flow:
+6 means that the field is required for flow number 6
-6 means that the field is not required for flow number 6
Vaults
PowerBoard has a PCI-compliant vault that lets you access and store customer payment details from all of your payment gateways. Our vault enables you to pre-fill customer card details and help your customers transact faster - regardless of the payment gateway you process transactions with.
The vault is built on the PowerBoard infrastructure so you do not take any liabilities or data risks.
Conditions
The response can differ depending on the payment method:
- Сredit card;
- Created by fetch.
Vault resource
| field | required [flow] | type | description |
|---|---|---|---|
| vault_token | + | string (UIID) | A vault token |
| created_at | + | string (ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ) | A vault token creation date |
| updated_at | + | string (ISO 8601 format - yyyy-mm-ddThh:mm:ss.sssZ) | A date of the last vault token update |
| archived | + | bool | For newly created vaults, it is always false, it is set to true after manual archiving |
| user_id | - | string (24 hex characters) | An ID of the request initiator if the request was made by the personal token (from the dashboard) |
| status | + | string | An actual vault status. See the status table |
| _source_ip_address | + | string | A client's IP address |
| first_name | - | string | A customer's first name |
| last_name | - | string | A customer's last name |
| - | string | A customer's email | |
| phone | - | string(E.164) | A customer's phone in the E.164 international notation (Example: +12345678901) |
| type | + | string | A type of payment source. card is for a source with a credit card. |
| card_name | +1 | string | A cardholder's name (as on card) |
| card_number_last4 | +1 | string (numeric) | Card number last 4 digits |
| card_number_bin | +1 | string (numeric) | Card BIN number |
| card_scheme | +1 | string | A card scheme (i.g. visa, mastercard etc...) |
| expire_month | +1 | string (mm) | A card expiration month |
| expire_year | +1 | string (yyyy) | A card expiration year |
| account_name | +2 | string | A customer's account name |
| account_number | +2 | string | A customer's account number |
| account_routing | -2 | string (numeric) | A customer's account number: BSB/Routing/SWIFT/IBAN Number |
| account_holder_type | -2 | string | An account type (personal or business) |
| address_line1 | - | string | A customer's address, line 1 |
| address_line2 | - | string | A customer's address, line 2 |
| address_state | - | string | A customer's address, state |
| address_country | - | string | A customer's address, country code |
| address_city | - | string | A customer's address, city |
| address_postcode | - | string | A customer's address, postcode |
| fetch_id | +2 | string (24 hex characters) | The ID of existing fetch that created the vault token |
Status
| status | description |
|---|---|
| active | A default status after creating |
| archived | A status after the vault token is manually archived |