post http://{{url}}/v1/charges/verification
A Verification charge is used to allow merchants to validate a customer's card prior to submitting a financial transaction to the gateway.
Flow
You can create a verification charge using:
- Credit card
- Vault token
Request body
field | required[flow] | type | description |
---|---|---|---|
amount | - | float | Only valid value is 0. If amount not provided 0 value is used by default |
currency | + | string (iso4217 alpha-3) | Currency code |
reference | - | string | Manually defined reference for customer in payment systems |
initialization_source | - | string | The mechanism the cardholder used to accept the transaction |
order_id | - | string | A unique value generated by the merchant to identify a order. Please ensure that a unique OrderID is provided as the provision of a non-unique OrderID by a merchant could result in a rejected transaction by the gateway as PowerBoard is unable to validate. |
transaction_id | - | string | A unique value generated by the merchant to identify a transaction. Please ensure that a unique TransactionID is provided as the provision of a non-unique TransactionID by a merchant could result in a rejected transaction by the gateway as PowerBoard is unable to validate. |
customer | +1, +2 | object | Object with the customer’s information. |
customer.first_name | - | string | Customer first name |
customer.last_name | - | string | Customer last name |
customer.email | - | string | Customer email |
customer.phone | - | string(E.164) | Customer phone in E.164 international notation (Example: +12345678901) |
customer.payment_source | + | object | Object with payment information |
customer.payment_source.vault_token | +2 | string (uiid) | vault token id |
customer.payment_source.gateway_id | + | string (24 hex characters) | Gateway id |
customer.payment_source.type | - | string | Type of payment. By default card. Use card for payment with credit card. |
customer.payment_source.source | - | string | Payment method source, Possible values are card_on_file, manual, app, unknown |
customer.payment_source.card_name | +2,-2 | string | Cardholder name (as on card) |
customer.payment_source.card_number | +2,-2 | string(numeric) | Card number |
customer.payment_source.expire_month | +2,-2 | string(mm) | Card expiration month mm |
customer.payment_source.expire_year | +2,-2 | string(yyyy) | Card expiration year |
customer.payment_source.card_ccv | -2, -2 | string(numeric) | Card CCV number |
customer.payment_source.address_line1 | - | string | Customer Address, line 1 |
customer.payment_source.address_line2 | - | string | Customer Address, line 2 |
customer.payment_source.address_state | - | string | Customer Address, State |
customer.payment_source.address_country | - | string | Customer Address, Country Code |
customer.payment_source.address_city | - | string | Customer Address, City |
customer.payment_source.address_postcode | - | string | Customer Address, Postcode |
customer.payment_source.card_accept_type | - | string | The mechanism the cardholder used to send card details |
customer.payment_source.card_holder_accept_method | - | string | The mechanism the cardholder used to accept the transaction |
custom_fields | - | object | The object of custom fields for transaction. These fields were sent to a payment gateway if this option has been enabled using the gateway creation and modification endpoints |
custom_fields.any | - | string | This fields can have any custom name and value |