--- title: "Payment: Refund" method: POST path: "/payments/{id}/refund" tags: ["Payments"] --- # Payment: Refund `POST /payments/{id}/refund` Refunds an arbitrary amount of money from an existing payment. If no amount is specified, the whole payment is refunded. ## Path parameters - `id` string, required — A unique 25-character alphanumeric resource identifier. ## Request body - RefundPaymentRequest - `amount` integer — The payment amount before tax, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `description` string - `platform_details` PlatformDetails - `submerchants` Submerchant[], required — Array of submerchant split configurations for this platform payment. - `submerchant_id` string, required — A unique 25-character alphanumeric merchant identifier. - `amount` integer, required — The amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `platform_fee` integer, required — The platform fee amount, tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `processing_merchant_id` string — A unique 25-character alphanumeric resource identifier. ## Response `200` 200 response - Payment - `id` string, required — A unique 25-character alphanumeric payment identifier. - `resource` 'payment', required — Resource name. Will always be `payment`. - `status` 'pending' | 'authorized' | 'captured' | 'cancelled' | 'expired' | 'refunded' | 'failed', required - `amount` integer, required — The payment amount before tax, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `tax` integer, required — The tax amount, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `customer` string, nullable, required — Customer UUID if associated with a customer, otherwise null. - `payment_deadline` string, date-time, nullable, required — Deadline by which the payment must be completed, or null. - `payment_details` union, required — Specific payment details and attributes for each payment type. It may include payment method specific attributes that are not part of the original request. - ResponsePaymentDetailsCreditCard - `type` 'credit_card', required — Payment method type. - `brand` string, required — Card brand (e.g. "visa", "mastercard", "jcb"). - `last_four_digits` string, required — Last four digits of the card number. - `month` integer, required — Credit card expiration month. - `year` integer, required — Credit card expiration year. If this value is less than 100, it will be treated as two digits year in the current century. E.g. If current year is `2024`, `99` means `2099`. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `verification_value` 'Approved' | 'Invalid' | 'Not Checked' | 'Not Supplied' - `name` string — Full name of the customer. This attribute takes precedence over `given_name` and `family_name`. - `given_name` string — Given name of the customer. - `family_name` string — Family name of the customer. - `expiry_days` integer - `intent` 'one_time' | 'card_on_file' | 'subscription' | 'installment' - `initiator` 'merchant' | 'customer' - `usage` 'first' | 'used' - `scheme_reference` string - `installments` '3' | '5' | '6' | '10' | '12' | '15' | '18' | '20' | '24' | 'revolving' — Specify the number of installment months or "revolving" payment. This feature only works for some acquirers, and only for `JPY` transactions. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsCreditCardBrazil - `type` 'credit_card_brazil', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `remote_payment_id` string, required — Remote payment identifier returned by the Brazilian payment gateway. - ResponsePaymentDetailsCreditCardKorea - `type` 'credit_card_korea', required — Payment method type. - `brand` string, required — Card brand (e.g. "visa", "mastercard", "jcb"). - `last_four_digits` string, required — Last four digits of the card number. - `month` integer, required — Credit card expiration month. - `year` integer, required — Credit card expiration year. If this value is less than 100, it will be treated as two digits year in the current century. E.g. If current year is `2024`, `99` means `2099`. - `verification_value` 'Approved' | 'Invalid' | 'Not Checked' | 'Not Supplied' - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsCreditCardTerminal - `type` 'credit_card_terminal', required — Payment method type. - `brand` string — Card brand (e.g. "visa", "mastercard"). - `last_four_digits` string — Last four digits of the card used. - `month` integer — Credit card expiration month. - `year` integer — Credit card expiration year. If this value is less than 100, it will be treated as two digits year in the current century. E.g. If current year is `2024`, `99` means `2099`. - `field55` string - `cardnet_status` string — Status code returned by the Cardnet network. - `approval_number` string — Approval number returned by the card network. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsAlipay - `type` 'alipay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_id` string — Transaction identifier returned by Alipay. - `redirect_url` string — URL to redirect the customer to for completing the Alipay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsAlipayHK - `type` 'alipay_hk', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the AlipayHK payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsAU - `type` 'au', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the au payment. - `transaction_id` string — Transaction identifier returned by au. - `pay_info_no` string — Payment information number for this au transaction. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsAupay - `type` 'aupay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_id` string, nullable — Transaction identifier returned by au PAY. - `redirect_url` string — URL to redirect the customer to for completing the au PAY payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsBancontact - `type` 'bancontact', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_key` string — Transaction key returned by Bancontact. - `redirect_url` string — URL to redirect the customer to for completing the Bancontact payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsBankTransfer - `type` 'bank_transfer', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention, payment instruction, and payment receipt. - `order_id` string — Order identifier for this bank transfer. - `bank_name` string — Name of the bank to transfer funds to. - `account_branch_name` string — Name of the bank branch. - `account_number` string — Bank account number to transfer funds to. - `account_type` string — Type of bank account. - `account_name` string — Name of the bank account holder. - `instructions_url` string — URL with payment instructions for the customer. - `payment_deadline` string, date-time — Deadline by which the bank transfer must be completed. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsBitCash - `type` 'bit_cash', required — Payment method type. - `email` string — Customer's email address. Will be used for fraud prevention and payment receipt. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsBlik - `type` 'blik', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the BLIK payment. - `transaction_id` string — Transaction identifier returned by BLIK. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsCultureVoucher - `type` 'culture_voucher', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `culture_id` string, required — Culture Land ID used for this voucher payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsCVS - `type` 'cvs', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `bardcode` string — Barcode number for the CVS payment slip. - `instructions_url` string — URL with payment instructions for the customer. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsDana - `type` 'dana', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the DANA payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsDocomo - `type` 'docomo', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the docomo payment. - `provider_order_number` string — Order number provided by carrier. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsDokuWallet - `type` 'doku_wallet', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the DOKU Wallet payment. - `transaction_id` string — Transaction identifier returned by DOKU. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsDospara - `type` 'dospara', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `user_no` string, required — Dospara user number used for this payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsDragonpay - `type` 'dragonpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Dragonpay payment. - `transaction_id` string — Transaction identifier returned by Dragonpay. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsEnets - `type` 'enets', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the eNETS payment. - `transaction_id` string — Transaction identifier returned by eNETS. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsEpospay - `type` 'epospay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `offsite_fake_new_path` string — When using test mode. - `offsite_url` string — URL for the customer to complete the EPOS payment offsite. - `merchant_id` string — Merchant identifier used in the EPOS payment request. - `shop_id` string — Shop identifier used in the EPOS payment request. - `deal_id` string — Deal identifier for this EPOS transaction. - `token` string — Authentication token for the EPOS payment. - `prd_list` string — Product list data for the EPOS payment. - `amount` integer — Payment amount in the lowest denomination of the currency. - `customer_id` string — Customer identifier in the EPOS system. - `return_url` string — URL to redirect the customer to after completing the EPOS payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsEps - `type` 'eps', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the eps payment. - `transaction_id` string — Transaction identifier returned by eps. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsFpx - `type` 'fpx', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the FPX payment. - `transaction_id` string — Transaction identifier returned by FPX. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsGCash - `type` 'gcash', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the GCash payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsGiropay - `type` 'giropay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_key` string — Transaction key returned by giropay. - `redirect_url` string — URL to redirect the customer to for completing the giropay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsHappyMoney - `type` 'happy_money', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `happy_money_id` string, required — Happy Money ID used for this payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsIdeal - `type` 'ideal', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transacion_key` string — Transaction key returned by iDEAL. - `redirect_url` string — URL to redirect the customer to for completing the iDEAL payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsKakaopay - `type` 'kakaopay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Kakao Pay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsKonbini - `type` 'konbini', required — Payment method type. - `store` 'seven-eleven' | 'lawson' | 'family-mart' | 'ministop' | 'daily-yamazaki' | 'seicomart', required - `email` string, required — Customer's email address. Will be used for fraud prevention, payment instruction, and payment receipt. - `confirmation_code` string, nullable — Confirmation code for the konbini payment slip. - `receipt` string, nullable — Receipt number for the konbini payment. - `instructions_url` string — URL with payment instructions for the customer. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsMerpay - `type` 'merpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_key` string — Transaction key returned by Merpay. - `redirect_url` string — URL to redirect the customer to for completing the Merpay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsMobileJapan - `type` 'japan_mobile', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `provider` 'au' | 'docomo' | 'softbank', required - `redirect_url` string — URL to redirect the customer to for completing the mobile carrier payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsMobile - `type` 'mobile', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `provider` string — Mobile carrier or payment provider for this payment. - `redirect_url` string — URL to redirect the customer to for completing the mobile payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsMultibanco - `type` 'multibanco', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Multibanco payment. - `transaction_id` string — Transaction identifier returned by Multibanco. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsMybank - `type` 'mybank', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the MyBank payment. - `transaction_id` string — Transaction identifier returned by MyBank. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsNarvesen - `type` 'narvesen', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Narvesen payment. - `transaction_id` string — Transaction identifier returned by Narvesen. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsNaverpay - `type` 'naverpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `callback_url` string — Callback URL used in the Naver Pay payment flow. - `mode` 'production' | 'development' — Environment mode for the Naver Pay integration. - `redirect` boolean — Whether the payment uses a redirect flow. - `offsite_fake_new_path` string — When using test mode. - `client_id` string — Naver Pay client ID for this merchant. - `digital_content_only` boolean — Whether this payment is for digital content only. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsNetCash - `type` 'net_cash', required — Payment method type. - `email` string — Customer's email address. Will be used for fraud prevention and payment receipt. - `short_amount` integer — Amount the payment is short by if insufficient funds were provided. - `prepaid_cards` PrepaidCards[] — List of prepaid cards used in this transaction. - `last_four_digits` string — Last four digits of the prepaid card number. - `points` integer — Points or remaining balance on this prepaid card. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsOvo - `type` 'ovo', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the OVO payment. - `transaction_id` string — Transaction identifier returned by OVO. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPaidy - `type` 'paidy', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Paidy payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. For Japanese addresses: building name, apartment number. Required for physical products. - `shipping_address_line2` string — Shipping address line 2. For Japanese addresses: district, land number, land number extension. - `shipping_address_city` string — Shipping address city. Name of city, municipality, or village. Required for physical products. - `shipping_address_state` string — Shipping address state / prefecture. Required for physical products. - `shipping_address_zip` string — Shipping address ZIP code, in a 7-digit format (NNN-NNNN). Required for physical products. - `shipping_address_country` string — Shipping address country. Required for physical products. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPayco - `type` 'payco', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `order_sheet_url` string — URL to the PAYCO order sheet for the customer. - `redirect_url` string — URL to redirect the customer to for completing the PAYCO payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPayEasy - `type` 'pay_easy', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention, payment instruction, and payment receipt. - `bank_id` string — Bank identifier for the Pay-easy payment. - `customer_id` string — Customer identifier for the Pay-easy payment. - `confirmation_id` string — Confirmation ID for the Pay-easy payment. - `instructions_url` string — URL with payment instructions for the customer. - `payment_url` string — URL where the customer can complete the Pay-easy payment online. - `cvs_code` string, nullable — CVS code for convenience store payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPayPay - `type` 'paypay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the PayPay payment. - `external_payment_id` string, nullable — Payment identifier returned by PayPay. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPaypost - `type` 'paypost', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the PayPost payment. - `transaction_id` string — Transaction identifier returned by PayPost. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPaysafeCard - `type` 'paysafe_card', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Paysafecard payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPaysafeCash - `type` 'paysafe_cash', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Paysafecash payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPaysera - `type` 'paysera', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Paysera payment. - `transaction_id` string — Transaction identifier returned by Paysera. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPayu - `type` 'payu', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the PayU payment. - `transaction_id` string — Transaction identifier returned by PayU. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPerlas - `type` 'perlas', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Perlas payment. - `transaction_id` string — Transaction identifier returned by Perlas. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPix - `type` 'pix', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the PIX payment. - `transaction_code` string — PIX transaction code. - `qr_code_url` string — URL to the QR code image for the PIX payment. - `pix_payment_code` string — PIX payment code that the customer can use to complete the payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPoli - `type` 'poli', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the POLi payment. - `transaction_id` string — Transaction identifier returned by POLi. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsPrzelewy24 - `type` 'przelewy24', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Przelewy24 payment. - `transaction_id` string — Transaction identifier returned by Przelewy24. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsRakutenpay - `type` 'rakutenpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `charge_key` string — Charge key returned by Rakuten Pay. - `redirect_url` string — URL to redirect the customer to for completing the Rakuten Pay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsSepaTransfer - `type` 'sepa_transfer', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_key` string — Transaction key returned by the SEPA transfer provider. - `redirect_url` string — URL to redirect the customer to for completing the SEPA transfer. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsSofortbanking - `type` 'sofortbanking', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `transaction_key` string — Transaction key returned by Sofort. - `redirect_url` string — URL to redirect the customer to for completing the Sofort payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsSoftbank - `type` 'softbank', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the SoftBank payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsToss - `type` 'toss', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `toss_pay_token` string — Token for the Toss Pay payment flow. - `qr_code` string — QR code data for the Toss payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsTNG - `type` 'tng', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the Touch'n Go payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsTruemoney - `type` 'truemoney', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the TrueMoney payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsUnionpay - `type` 'unionpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `redirect_url` string — URL to redirect the customer to for completing the UnionPay payment. - `transaction_id` string — Transaction identifier returned by UnionPay. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsWebMoney - `type` 'web_money', required — Payment method type. - `email` string — Customer's email address. Will be used for fraud prevention and payment receipt. - `short_amount` integer — Amount the payment is short by if insufficient funds were provided. - `prepaid_cards` PrepaidCards[] — List of prepaid cards used in this transaction. - `last_four_digits` string — Last four digits of the prepaid card number. - `points` integer — Points or remaining balance on this prepaid card. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - ResponsePaymentDetailsWechatpay - `type` 'wechatpay', required — Payment method type. - `email` string, required — Customer's email address. Will be used for fraud prevention and payment receipt. - `qr_code_url` string — URL to the QR code image for the WeChat Pay payment. - `mweb_url` string — Mobile web URL for the WeChat Pay payment flow. - `trade_type` 'NATIVE' | 'MWEB' — WeChat Pay trade type: NATIVE for QR code, MWEB for mobile web. - `redirect_url` string — URL to redirect the customer to for completing the WeChat Pay payment. - `shipping_address_name` string — Shipping address name. This is the recipient's name. - `shipping_address_line1` string — Shipping address line 1. - `shipping_address_line2` string — Shipping address line 2. - `shipping_address_city` string — Shipping address city. - `shipping_address_state` string — Shipping address state. - `shipping_address_zip` string — Shipping address ZIP code. - `shipping_address_country` string — Shipping address country. - `billing_address_name` string — Billing address name. This is the paying customer's name. - `billing_address_line1` string — Billing address line 1. - `billing_address_line2` string — Billing address line 2. - `billing_address_city` string — Billing address city. - `billing_address_state` string — Billing address state. - `billing_address_zip` string — Billing address ZIP code. - `billing_address_country` string — Billing address country. - `payment_method_fee` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `total` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code. - `description` string, nullable, required — A description for this payment. May be null if it's not set. - `captured_at` string, date-time, nullable, required — Timestamp when the payment was captured, or null if not yet captured. - `external_order_num` string, nullable, required — Merchant-assigned external order number for this payment. - `metadata` object, required — Arbitrary key-value metadata attached at payment creation time. - `created_at` string, date-time, required — Timestamp when the payment was created. - `amount_refunded` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `locale` 'ja' | 'en' | 'ko', required — For supported payment methods, sets the language of the instruction page. - `session` string, required — A unique 25-character alphanumeric resource identifier. - `customer_family_name` string, nullable, required — Customer's family name. - `customer_given_name` string, nullable, required — Customer's given name. - `mcc` string, nullable, required — Merchant Category Code used for this payment. - `statement_descriptor` StatementDescriptor, required — On supported merchant and supported payment methods, specify a custom statement descriptor for this payment. This helps customer to identify the payment on their statement. See [Dynamic Statement Descriptors & MCCs](https://doc.komoju.com/docs/payments-with-dynamic-statement-descriptors) for more information. - `statement_descriptor` string — Full statement descriptor in Japanese or English. - `statement_descriptor_alpha` string — Statement descriptor in alphanumeric characters. - `statement_descriptor_kana` string — Statement descriptor in katakana characters. - `statement_city` string — Name of the city to be shown on the statement. - `contact_phone` string — Contact phone number to be shown on the statement. - `platform_details` PlatformDetails - `submerchants` Submerchant[], required — Array of submerchant split configurations for this platform payment. - `submerchant_id` string, required — A unique 25-character alphanumeric merchant identifier. - `amount` integer, required — The amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `platform_fee` integer, required — The platform fee amount, tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `processing_merchant_id` string — A unique 25-character alphanumeric resource identifier. - `refunds` Refund[], required — An array of refunds. Will be an empty array if there are no refunds. - `id` string, required — A unique 25-character alphanumeric refund identifier. - `resource` 'refund', required — Resource name. Will always be `refund`. - `amount` integer, required — The refund amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `currency` 'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND', required — 3-letter ISO currency code. - `payment` string, required — A unique 25-character alphanumeric payment identifier. - `description` string, required — Description of the refund. - `created_at` string, date-time, required - `chargeback` boolean, required — Denotes if this refund was created due to a chargeback. - `refund_type` string - `platform_details` PlatformDetails - `submerchants` Submerchant[], required — Array of submerchant split configurations for this platform payment. - `submerchant_id` string, required — A unique 25-character alphanumeric merchant identifier. - `amount` integer, required — The amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `platform_fee` integer, required — The platform fee amount, tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `processing_merchant_id` string — A unique 25-character alphanumeric resource identifier. - `refund_requests` RefundRequest[], required — An array of refund requests. Will be an empty array if there are no refund requests. - `id` string, required — A unique 25-character alphanumeric refund request identifier. - `payment` string, required — A unique 25-character alphanumeric payment identifier. - `customer_name` string, required — Customer's name in half-width katakana characters. - `bank_name` string, required — The name of the bank that customer would like money to be deposited to. - `bank_code` string, required — 4-digit bank code. May be `null` if it's not given. - `branch_name` string, required — The name of the branch. - `branch_number` string, required — 3-digit branch number. - `account_number` string, required — 7-digit account number. - `description` string — Optional description or reason for this refund request. - `status` 'pending' | 'rejected' | 'completed', required — Status of the refund request. - `created_at` string, date-time, required — Timestamp when the refund request was created. - `platform_details` PlatformDetails - `submerchants` Submerchant[], required — Array of submerchant split configurations for this platform payment. - `submerchant_id` string, required — A unique 25-character alphanumeric merchant identifier. - `amount` integer, required — The amount with tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `platform_fee` integer, required — The platform fee amount, tax included, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD). - `processing_merchant_id` string — A unique 25-character alphanumeric resource identifier. ## Other responses - `403` — Invalid authorization - `404` — Payment does not exist - `422` — Not refundable - `503` — Maintenance --- [API](https://skmtc.net/komoju/apis/komoju-api.md) · [All operations](https://skmtc.net/komoju/apis/komoju-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/komoju/komoju-api/versions/65483c40ba32/schema)