post
http://{url}{}/v1/charges/wallet
A сharge for the wallet is a method that creates a token to utilize in the Client SDK. It initializes payments using Apple/Google Pay, PayPal Smart, AfterPay, etc.
Request query params
| field | type | description |
|---|---|---|
| capture | bool | Automatically capturing or just authorize. By default true |
Request body
| field | required [flow] | type | description |
|---|---|---|---|
| amount | + | float | An amount of the payment |
| currency | + | string (iso4217 alpha-3) | A currency code |
| description | - | string | A manually defined description for payments in payment systems |
| reference | - | string | A manually defined reference for payments in payment systems |
| customer | + | object | An object with the customer’s information |
| customer.first_name | - | string | A customer's first name |
| customer.last_name | - | string | A customer's last name |
| customer.email | - | string | A customer's email |
| customer.phone | - | string(E.164) | A customer's phone in the E.164 international notation (Example: +12345678901) |
| customer.reference | - | string | A customer's reference |
| customer.payment_source | + | object | An object with payment source information |
| customer.payment_source.gateway_id | + | string (24 hex characters) | A gateway ID used for the customer's payment source |
| customer.payment_source.address_line1 | - | string | The customer's payment source address, line 1 |
| customer.payment_source.address_line2 | - | string | The customer's payment source address, line 2 |
| customer.payment_source.address_line3 | - | string | The customer's payment source address, line 3 |
| customer.payment_source.city | - | string | The customer's payment source address city |
| customer.payment_source.state | - | string | The customer's payment source address state |
| customer.payment_source.postcode | - | string | The customer's payment source address post code |
| customer.payment_source.country | - | string | The customer's payment source address country |
| meta.store_id | - | string | A store ID (required for a Flypay gateway) |
| meta.store_name | - | string | A store name (required for Flypay and Apple Pay (via MPGS) gateways) |
| meta.success_url | - | string | Merchant site success redirect URL (required for Afterpay) |
| meta.error_url | - | string | Merchant site error redirect URL (required for Afterpay) |
| shipping | - | object | Shipping details of the transaction |
| shipping.address_line1 | - | string | The customer's shipping address, line 1 |
| shipping.address_line2 | - | string | The customer's shipping address, line 2 |
| shipping.address_line3 | - | string | The customer's shipping address, line 3 |
| shipping.address_state | - | string | The customer's shipping address, state |
| shipping.address_country | - | string | The customer's shipping address, country |
| shipping.address_city | - | string | The customer's shipping address, city |
| shipping.address_postcode | - | string | The customer's shipping address, postcode |
| shipping.address_origin_postcode | - | string | The customer's shipping address, origin postcode |
| shipping.address_company | - | string | The customer's shipping address, company |
| shipping.method | - | string | The customer's shipping method for a transaction |
| shipping.amount | - | string | The customer's shipping amount (required for Afterpay) |
| shipping.currency | - | string | The customer's shipping currency (required for Afterpay) |
| shipping.contact | - | object | The customer's shipping contact info |
| shipping.contact.phone | - | string | The customer's shipping contact phone number |
| shipping.contact.first_name | - | string | The customer's shipping contact first name |
| shipping.contact.last_name | - | string | The customer's shipping contact last name |
| items | - | array | Only for Afterpay (optional), each item could have amount, name, type, quantity, item_uri and image_uri. |
| items[].name | - | string | Item name |
| items[].type | - | string | Item type |
| items[].quantity | - | number | Item quantity |
| items[].item_uri | - | string | Item uri |
| items[].image_uri | - | string | Item image uri |
| item[].amount | - | string (numeric) | Item amount |
Response body
| field | required [flow] | type | description |
|---|---|---|---|
| token | + | string | A token to be used in the Client SDK to process Apple/Google Pay, PayPal Smart, AfterPay, etc. transactions |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…