When to use this
Refund or pay out a customer via bank transfer rather than back to card. Useful for claim settlements, late refunds, or payouts to non-cardholders.
Endpoint
POST https://accounts.paytia.com/api/payment_service
Try it
Paste your sandbox key, edit any field, and hit Execute. Nothing is stored — the key travels to the Paytia proxy and the response comes straight back.
Sandbox or live key — nothing is stored.
String: WEBHOOK TRANSACTION URL FOR PAYMENT STAGE (URL on which we will send payment gateway response to the third party)
String: A 'UNQUIQUE' ID value for the transaction. This is passed back with each webhook response so you can track the transaction flow.
String: Stripe and Braintree ONLY This field control allows you to post the cus_ value (Stripe), or the CustomerID or a new ID value (Braintree)., representing the customer record the transaction should be placed for.
String: The token that was returned after a successful capture form is stored.
Integer: Enum (0 - 9) 0 = Phone - None required = immediate charge 1 = Phone - Capture - Tokenisation only (ensure you send 0.00 in amount) 2 = Phone - Pre-auth (Capture to pre-auth (reserve) and take an immediate payment) 3 = Phone - Pre-auth only (set a reserve on a card and return a transaction token) 4 = Link to Pay 5 = Phone - Recurring payment 6 = Bank to bank payments (to be added) 7 = Phone - Rolling reserve (Stripe only) 8 = Checkout payment type (used for "Checkout" in thirdparty/payment_service and API/payment_service) 9 = Bank outbound payment processing
String: Three alpha character values (If null then the default currency will pick up from merchant account according to country set) Currenly currency is controlled only from Operating settings in the merchant portal https://demo.pay729.{domain_extension}/merchant/addon_license_country
Decimal: A numeric value for the transaction gross charge stated to two decimal places
String: The value to be sent should be "bank".
curl --location --request POST 'https://accounts.paytia.com/api/payment_service' \
--header 'X-API-KEY: YOUR_API_KEY' \
--form 'webhook_url_transaction={ADD YOUR WEBHOOK URL HERE}' \
--form 'reference_id={ADD YOUR UNIQUE REFERENCE VALUE HERE}' \
--form 'gateway_customer_id={ADD YOUR gateway_customer_id VALUE HERE}' \
--form 'token_id={ADD YOUR token_id VALUE HERE}' \
--form 'transaction_flag=9' \
--form 'currency_code=GBP' \
--form 'amount=0.00' \
--form 'mode=bank'No response yet. Paste your key, tweak the values, and click Execute.
Fields
Full field-by-field reference below. Required vs optional varies by flow — the try-it explorer above starts with sensible defaults.
| Field | Type | Description |
|---|---|---|
| webhook_url_transaction | text | String: WEBHOOK TRANSACTION URL FOR PAYMENT STAGE (URL on which we will send payment gateway response to the third party) |
| reference_id | text | String: A 'UNQUIQUE' ID value for the transaction. This is passed back with each webhook response so you can track the transaction flow. |
| gateway_customer_id | text | String: Stripe and Braintree ONLY This field control allows you to post the cus_ value (Stripe), or the CustomerID or a new ID value (Braintree)., representing the customer record the transaction should be placed for. |
| token_id | text | String: The token that was returned after a successful capture form is stored. |
| transaction_flag | select | Integer: Enum (0 - 9) 0 = Phone - None required = immediate charge 1 = Phone - Capture - Tokenisation only (ensure you send 0.00 in amount) 2 = Phone - Pre-auth (Capture to pre-auth (reserve) and take an immediate payment) 3 = Phone - Pre-auth only (set a reserve on a card and return a transaction token) 4 = Link to Pay 5 = Phone - Recurring payment 6 = Bank to bank payments (to be added) 7 = Phone - Rolling reserve (Stripe only) 8 = Checkout payment type (used for "Checkout" in thirdparty/payment_service and API/payment_service) 9 = Bank outbound payment processing |
| currency_code | text | String: Three alpha character values (If null then the default currency will pick up from merchant account according to country set) Currenly currency is controlled only from Operating settings in the merchant portal https://demo.pay729.{domain_extension}/merchant/addon_license_country |
| amount | text | Decimal: A numeric value for the transaction gross charge stated to two decimal places |
| mode | text | String: The value to be sent should be "bank". |