diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 4fae3e42..a0aadd5c 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -7,8 +7,6 @@ client.go common/common.go configuration.go docs/RefundApi.md -docs/header.jpg -docs/refund.yaml docs/refund/CreateRefund.md docs/refund/CreateRefund400Response.md docs/refund/CreateRefund403Response.md @@ -20,6 +18,7 @@ docs/refund/Refund.md docs/refund/RefundList.md go.mod go.sum +images/header.jpg refund/api_refund.go refund/model_create_refund.go refund/model_create_refund_400_response.go diff --git a/README.md b/README.md index e58baa36..6b762dde 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -![Xendit PHP SDK](docs/header.jpg "Xendit Go SDK") +![Xendit Go SDK](images/header.jpg "Xendit Go SDK") # Xendit Go SDK The official Xendit Go SDK provides a simple and convenient way to call Xendit's REST API in applications written in Go. -* Package version: 3.4.0 +* Package version: 3.6.0 # Getting Started diff --git a/balance_and_transaction/model_balance.go b/balance_and_transaction/model_balance.go index 41f04266..cf5ccfc2 100644 --- a/balance_and_transaction/model_balance.go +++ b/balance_and_transaction/model_balance.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_channels_categories.go b/balance_and_transaction/model_channels_categories.go index a2ca428e..0d66c367 100644 --- a/balance_and_transaction/model_channels_categories.go +++ b/balance_and_transaction/model_channels_categories.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_currency.go b/balance_and_transaction/model_currency.go index e107077f..3bc41b61 100644 --- a/balance_and_transaction/model_currency.go +++ b/balance_and_transaction/model_currency.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_date_range_filter.go b/balance_and_transaction/model_date_range_filter.go index 4c3ad296..7dab038a 100644 --- a/balance_and_transaction/model_date_range_filter.go +++ b/balance_and_transaction/model_date_range_filter.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_fee_response.go b/balance_and_transaction/model_fee_response.go index 7f7947a0..699589a0 100644 --- a/balance_and_transaction/model_fee_response.go +++ b/balance_and_transaction/model_fee_response.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_link_item.go b/balance_and_transaction/model_link_item.go index 51414dd3..a950916c 100644 --- a/balance_and_transaction/model_link_item.go +++ b/balance_and_transaction/model_link_item.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_server_error.go b/balance_and_transaction/model_server_error.go index 7fd139c7..168f88fd 100644 --- a/balance_and_transaction/model_server_error.go +++ b/balance_and_transaction/model_server_error.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_transaction_response.go b/balance_and_transaction/model_transaction_response.go index 59ab923e..00750f23 100644 --- a/balance_and_transaction/model_transaction_response.go +++ b/balance_and_transaction/model_transaction_response.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_transaction_response_type.go b/balance_and_transaction/model_transaction_response_type.go index 3c828d86..4864dd0c 100644 --- a/balance_and_transaction/model_transaction_response_type.go +++ b/balance_and_transaction/model_transaction_response_type.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_transaction_statuses.go b/balance_and_transaction/model_transaction_statuses.go index 7266e2ca..45b151cd 100644 --- a/balance_and_transaction/model_transaction_statuses.go +++ b/balance_and_transaction/model_transaction_statuses.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_transaction_types.go b/balance_and_transaction/model_transaction_types.go index ff669cd9..d481edb3 100644 --- a/balance_and_transaction/model_transaction_types.go +++ b/balance_and_transaction/model_transaction_types.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_transactions_response.go b/balance_and_transaction/model_transactions_response.go index 02c13957..bcaca9f5 100644 --- a/balance_and_transaction/model_transactions_response.go +++ b/balance_and_transaction/model_transactions_response.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/balance_and_transaction/model_validation_error.go b/balance_and_transaction/model_validation_error.go index df34ea93..4aed40f8 100644 --- a/balance_and_transaction/model_validation_error.go +++ b/balance_and_transaction/model_validation_error.go @@ -3,7 +3,7 @@ Transaction Service V4 API # Introduction This specification describes how to use the Transaction Service V4 API. **Transaction Service** is the service that records the customer transactions and is responsible to calculate their balance. All products that move customer money around whether it is money-in, money-out, or transfer will interact with the Transaction Service on its flow. Transaction Service is the source of truth of Xendit and Customer regarding how much money that customer has that is stored in Xendit. Transaction Service is the source that is used for both our internal and customer financial reconciliation. Internally, the Transaction Service data structure is similar to how double-entry accounting works. ## How Xendit teams/services do integrate with Transaction Service V4 **Channel product team/service** They interact with the Transaction Service when they want to record the transactions. This transaction can be money-in (balance added), money-out (balance deducted), transfer, refund/void/reversal, or other kind of transaction that affects customer balance. Product team also interacts with the Transaction Service for getting information about the transaction or balance. **Billing/Fee team/service** They interact with Transaction Service either as the dependency of Transaction Service for getting the correct fee calculation/settings. Or using Transaction Service for getting the transaction/fee information to calculate the bill for the customer. **NUX team/service** They interact with the Transaction Service to set up the customer ledger_account that is used to record their transactions. **Finance team/service** They interact with the Transaction Service to get the transaction and balance data for each customer to do reconciliation. **Dashboard/API team/service** They interact with the Transaction Service as a proxy to show the data to the Customer. ## Prerequisites Before staring to use **Transaction Service API** you need to complete a few things: 1. Find out **Base URL** for the API. Every endpoint definition in this document contains list of available servers (local, staging, production) 2. Set up ledger accounts using business id and currency. **Ledger Account** represents the account of the customer that will be used to associate with ledger lines. Each business may have at least 1 ledger account group (a group consists of a few accounts of types such as cash, liability, holding), and the money movement of their ledger will revolve around those ledger accounts. **Ledger Lines** that show a debit or credit transaction for a ledger account. We’re using the double-entry principle in accounting where we should post 2 lines every time we make a transaction, 1 to debit an account and 1 to credit another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup) section of this document 3. To be able to create payments with fee/VAT the Product rate settings and VAT rate settings should be created using Transaction Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate settings. ## Transaction flows To integrate with the Transaction Service you should decide what types of transaction flows your integration will be using. Transaction flow is set by the transaction `type` during transaction creation 1. Money In flows 1. Payment from credit card `type: CREDIT_CARD_PAYMENT` 3. Payment from other sources without fee/VAT `type: DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT` 4. Payment from other sources with fee/VAT `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CRYPTO_PAYMENT` 5. Billing deposit from cash `type: BILLING_DEPOSIT` 6. Billing deposit from other sources `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT` 2. Money out flows 1. Instant payment `type: simple money out types` `status: COMPLETED` 2. Simple payment without fee/VAT `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL` 3. Simple payment with fee/VAT `type: ISSUING_FUNDING, BATCH_DISBURSEMENT, CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT` 4. Billing withdraw to cash `type: BILLING_WITHDRAWAL` 4. Billing withdraw to other destinations `type: BILL_PAYMENT` 3. Reversal flow Some of transactions could be reversed. See Reversible / non reversible transaction types section of this document. To reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `REVERSED`. 4. Void/Cancellation Flow Transaction in the `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id) endpoint with the transaction status `VOIDED`. 5. Switcher flow Switchers are transactions that do not affect the customer balance. These are transactions that goes directly to the customers’ account and simply passes through Xendit. Therefore, it will not impact the customer balance and we will only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment` field to `true`. ## Instant/non instant settlement Transactions can be performed instantly (instant settlement) or with delay (non instant settlement). Some of the transaction types are only instantly processed, some of them support both instant and non instant settlement and some of them have only non instant settlement. If settlement is instant than balance will be changed instantly. In opposite case the transaction status has to be set into PENDING_SETTLEMENT and settlement date should be provided. 1. Instant settlement Money In transaction types `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM` 2. Both instant and non instant Money In transaction types `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE, PAYLATER_PAYMENT` 3. Non Instant settlement Money In transaction types `CREDIT_CARD_PAYMENT` 4. Instant settlement Money Out transaction types `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING, BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION` 5. Both instant and non instant settlement supported Money Out transaction types `CHARGEBACK_DEDUCTION` 6. Non Instant settlement Money Out transaction types All other money out types are non instant settlement ## Reversible / non reversible transaction types Some transactions can be reversed. Here are the list of transaction types that could be reversed: `CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT, FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT, IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT, CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT, EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT, BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT, BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK` ## How to create transaction After you created or already have the `BUSINESS_CASH` ledger account ID (See Prerequisites section) and you know what transaction flows are going to be used you can create the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint ## How to update transaction To update transaction you should do PATCH request to the Update transaction (/api/transactions/::id) endpoint -API version: 3.4.3 +API version: 3.5.0 */ diff --git a/client.go b/client.go index 1faf1a16..a1557db1 100644 --- a/client.go +++ b/client.go @@ -154,7 +154,7 @@ func (c *APIClient) PrepareRequest( headerParams["xendit-lib"] = "go" // TODO: overwrite this line from buddy pipeline - headerParams["xendit-lib-ver"] = "3.4.0" + headerParams["xendit-lib-ver"] = "3.6.0" var body *bytes.Buffer diff --git a/configuration.go b/configuration.go index 773d7555..a049b9a0 100644 --- a/configuration.go +++ b/configuration.go @@ -78,7 +78,7 @@ var Default Configuration = *NewConfiguration() func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/3.4.0/go", + UserAgent: "OpenAPI-Generator/3.6.0/go", Debug: false, Servers: ServerConfigurations{ { diff --git a/docs/BalanceApi.md b/docs/BalanceApi.md index 942dfbfb..6f4017bf 100644 --- a/docs/BalanceApi.md +++ b/docs/BalanceApi.md @@ -1,20 +1,60 @@ -# xendit\BalanceApi +# BalanceApi + + +You can use the APIs below to interface with Xendit's `BalanceApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**GetBalance**](BalanceApi.md#GetBalance) | **Get** /balance | Retrieves balances for a business, default to CASH type | +| [**GetBalance**](BalanceApi.md#getbalance-function) | **Get** /balance | Retrieves balances for a business, default to CASH type | -## GetBalance +## `GetBalance()` Function Retrieves balances for a business, default to CASH type -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetBalance` | +| Path Parameters | [GetBalancePathParams](#request-parameters--GetBalancePathParams) | +| Request Parameters | [GetBalanceRequestParams](#request-parameters--GetBalanceRequestParams) | +| Return Type | [**Balance**](balance_and_transaction/Balance.md) | + +### Path Parameters - GetBalancePathParams +This endpoint does not need any path parameter. + + +### Request Parameters - GetBalanceRequestParams + +Parameters that are passed through a pointer to a apiGetBalanceRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **accountType** |**string**| | ["CASH"] | +| **currency** |**string**| | | +| **forUserId** |**string**| | | + +### Usage Example ```go package main @@ -62,30 +102,4 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetBalanceRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **accountType** |**string**| The selected balance type | [default to "CASH"] | -| **currency** |**string**| Currency for filter for customers with multi currency accounts | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | | - -### Return type - -[**Balance**](balance_and_transaction/Balance.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/CustomerApi.md b/docs/CustomerApi.md index 6575eb4c..99517b13 100644 --- a/docs/CustomerApi.md +++ b/docs/CustomerApi.md @@ -1,23 +1,63 @@ -# xendit\CustomerApi +# CustomerApi + + +You can use the APIs below to interface with Xendit's `CustomerApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreateCustomer**](CustomerApi.md#CreateCustomer) | **Post** /customers | Create Customer | -| [**GetCustomer**](CustomerApi.md#GetCustomer) | **Get** /customers/{id} | Get Customer By ID | -| [**GetCustomerByReferenceID**](CustomerApi.md#GetCustomerByReferenceID) | **Get** /customers | GET customers by reference id | -| [**UpdateCustomer**](CustomerApi.md#UpdateCustomer) | **Patch** /customers/{id} | Update End Customer Resource | +| [**CreateCustomer**](CustomerApi.md#createcustomer-function) | **Post** /customers | Create Customer | +| [**GetCustomer**](CustomerApi.md#getcustomer-function) | **Get** /customers/{id} | Get Customer By ID | +| [**GetCustomerByReferenceID**](CustomerApi.md#getcustomerbyreferenceid-function) | **Get** /customers | GET customers by reference id | +| [**UpdateCustomer**](CustomerApi.md#updatecustomer-function) | **Patch** /customers/{id} | Update End Customer Resource | -## CreateCustomer +## `CreateCustomer()` Function Create Customer -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreateCustomer` | +| Path Parameters | [CreateCustomerPathParams](#request-parameters--CreateCustomerPathParams) | +| Request Parameters | [CreateCustomerRequestParams](#request-parameters--CreateCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | + +### Path Parameters - CreateCustomerPathParams +This endpoint does not need any path parameter. + + +### Request Parameters - CreateCustomerRequestParams + +Parameters that are passed through a pointer to a apiCreateCustomerRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotencyKey** |**string**| | | +| **forUserId** |**string**| | | +| **customerRequest** |[**CustomerRequest**](customer/CustomerRequest.md)| | | + +### Usage Example ```go package main @@ -62,41 +102,37 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters +## `GetCustomer()` Function -Other parameters are passed through a pointer to a apiCreateCustomerRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **idempotencyKey** |**string**| A unique key to prevent processing duplicate requests. | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. | | -| **customerRequest** |[**CustomerRequest**](customer/CustomerRequest.md)| Request object for end customer object | | - -### Return type +Get Customer By ID -[**Customer**](customer/Customer.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetCustomer` | +| Path Parameters | [GetCustomerPathParams](#request-parameters--GetCustomerPathParams) | +| Request Parameters | [GetCustomerRequestParams](#request-parameters--GetCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetCustomerPathParams -## GetCustomer +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **id** | **string** | End customer resource id | ☑️ | | -Get Customer By ID +### Request Parameters - GetCustomerRequestParams +Parameters that are passed through a pointer to a apiGetCustomerRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -136,44 +172,33 @@ func main() { } ``` -### Path Parameters - +## `GetCustomerByReferenceID()` Function -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **id** | **string** | End customer resource id | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetCustomerRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. | | - -### Return type +GET customers by reference id -[**Customer**](customer/Customer.md) -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetCustomerByReferenceID` | +| Path Parameters | [GetCustomerByReferenceIDPathParams](#request-parameters--GetCustomerByReferenceIDPathParams) | +| Request Parameters | [GetCustomerByReferenceIDRequestParams](#request-parameters--GetCustomerByReferenceIDRequestParams) | +| Return Type | [**GetCustomerByReferenceID200Response**](customer/GetCustomerByReferenceID200Response.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetCustomerByReferenceIDPathParams +This endpoint does not need any path parameter. -## GetCustomerByReferenceID +### Request Parameters - GetCustomerByReferenceIDRequestParams -GET customers by reference id +Parameters that are passed through a pointer to a apiGetCustomerByReferenceIDRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **referenceId** |**string**| ☑️ | | +| **forUserId** |**string**| | | - -### Example +### Usage Example ```go package main @@ -214,40 +239,38 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetCustomerByReferenceIDRequest struct via the builder pattern +## `UpdateCustomer()` Function +Update End Customer Resource -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **referenceId** |**string**| Merchant's reference of end customer | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. | | -### Return type -[**GetCustomerByReferenceID200Response**](customer/GetCustomerByReferenceID200Response.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `UpdateCustomer` | +| Path Parameters | [UpdateCustomerPathParams](#request-parameters--UpdateCustomerPathParams) | +| Request Parameters | [UpdateCustomerRequestParams](#request-parameters--UpdateCustomerRequestParams) | +| Return Type | [**Customer**](customer/Customer.md) | -### HTTP request headers +### Path Parameters - UpdateCustomerPathParams -- **Content-Type**: Not defined -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **id** | **string** | End customer resource id | ☑️ | | +### Request Parameters - UpdateCustomerRequestParams -## UpdateCustomer - -Update End Customer Resource - +Parameters that are passed through a pointer to a apiUpdateCustomerRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **patchCustomer** |[**PatchCustomer**](customer/PatchCustomer.md)| | | -### Example +### Usage Example ```go package main @@ -291,34 +314,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **id** | **string** | End customer resource id | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiUpdateCustomerRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. | | -| **patchCustomer** |[**PatchCustomer**](customer/PatchCustomer.md)| Update Request for end customer object | | - -### Return type - -[**Customer**](customer/Customer.md) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/InvoiceApi.md b/docs/InvoiceApi.md index 4bcddf3b..ff77711a 100644 --- a/docs/InvoiceApi.md +++ b/docs/InvoiceApi.md @@ -1,21 +1,60 @@ -# xendit\InvoiceApi +# InvoiceApi + + +You can use the APIs below to interface with Xendit's `InvoiceApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreateInvoice**](InvoiceApi.md#CreateInvoice) | **Post** /v2/invoices/ | Create an invoice | -| [**GetInvoiceById**](InvoiceApi.md#GetInvoiceById) | **Get** /v2/invoices/{invoice_id} | Get invoice by invoice id | -| [**GetInvoices**](InvoiceApi.md#GetInvoices) | **Get** /v2/invoices | Get all Invoices | -| [**ExpireInvoice**](InvoiceApi.md#ExpireInvoice) | **Post** /invoices/{invoice_id}/expire! | Manually expire an invoice | +| [**CreateInvoice**](InvoiceApi.md#createinvoice-function) | **Post** /v2/invoices/ | Create an invoice | +| [**GetInvoiceById**](InvoiceApi.md#getinvoicebyid-function) | **Get** /v2/invoices/{invoice_id} | Get invoice by invoice id | +| [**GetInvoices**](InvoiceApi.md#getinvoices-function) | **Get** /v2/invoices | Get all Invoices | +| [**ExpireInvoice**](InvoiceApi.md#expireinvoice-function) | **Post** /invoices/{invoice_id}/expire! | Manually expire an invoice | -## CreateInvoice +## `CreateInvoice()` Function Create an invoice -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreateInvoice` | +| Path Parameters | [CreateInvoicePathParams](#request-parameters--CreateInvoicePathParams) | +| Request Parameters | [CreateInvoiceRequestParams](#request-parameters--CreateInvoiceRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | + +### Path Parameters - CreateInvoicePathParams +This endpoint does not need any path parameter. + + +### Request Parameters - CreateInvoiceRequestParams + +Parameters that are passed through a pointer to a apiCreateInvoiceRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **createInvoiceRequest** |[**CreateInvoiceRequest**](invoice/CreateInvoiceRequest.md)| ☑️ | | +| **forUserId** |**string**| | | + +### Usage Example ```go package main @@ -55,38 +94,35 @@ func main() { } ``` -### Path Parameters - +## `GetInvoiceById()` Function +Get invoice by invoice id -### Other Parameters - -Other parameters are passed through a pointer to a apiCreateInvoiceRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **createInvoiceRequest** |[**CreateInvoiceRequest**](invoice/CreateInvoiceRequest.md)| | | -| **forUserId** |**string**| Business ID of the sub-account merchant (XP feature) | | - -### Return type - -[**Invoice**](invoice/Invoice.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetInvoiceById` | +| Path Parameters | [GetInvoiceByIdPathParams](#request-parameters--GetInvoiceByIdPathParams) | +| Request Parameters | [GetInvoiceByIdRequestParams](#request-parameters--GetInvoiceByIdRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | -### HTTP request headers +### Path Parameters - GetInvoiceByIdPathParams -- **Content-Type**: application/json -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **invoiceId** | **string** | Invoice ID | ☑️ | | +### Request Parameters - GetInvoiceByIdRequestParams -## GetInvoiceById +Parameters that are passed through a pointer to a apiGetInvoiceByIdRequest struct via the builder pattern -Get invoice by invoice id +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -126,42 +162,44 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **invoiceId** | **string** | Invoice ID | | - -### Other Parameters +## `GetInvoices()` Function -Other parameters are passed through a pointer to a apiGetInvoiceByIdRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| Business ID of the sub-account merchant (XP feature) | | - -### Return type - -[**Invoice**](invoice/Invoice.md) +Get all Invoices -### HTTP request headers +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetInvoices` | +| Path Parameters | [GetInvoicesPathParams](#request-parameters--GetInvoicesPathParams) | +| Request Parameters | [GetInvoicesRequestParams](#request-parameters--GetInvoicesRequestParams) | +| Return Type | [**[]Invoice**](invoice/Invoice.md) | -- **Content-Type**: Not defined -- **Accept**: application/json +### Path Parameters - GetInvoicesPathParams +This endpoint does not need any path parameter. -[[Back to top]](#) -[[Back to README]](../README.md) +### Request Parameters - GetInvoicesRequestParams -## GetInvoices +Parameters that are passed through a pointer to a apiGetInvoicesRequest struct via the builder pattern -Get all Invoices +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **externalId** |**string**| | | +| **statuses** |[**InvoiceStatus[]**](invoice/InvoiceStatus.md)| | | +| **limit** |**float32**| | | +| **createdAfter** |**time.Time**| | | +| **createdBefore** |**time.Time**| | | +| **paidAfter** |**time.Time**| | | +| **paidBefore** |**time.Time**| | | +| **expiredAfter** |**time.Time**| | | +| **expiredBefore** |**time.Time**| | | +| **lastInvoice** |**string**| | | +| **clientTypes** |[**InvoiceClientType[]**](invoice/InvoiceClientType.md)| | | +| **paymentChannels** |**string[]**| | | +| **onDemandLink** |**string**| | | +| **recurringPaymentId** |**string**| | | -### Example +### Usage Example ```go package main @@ -170,7 +208,7 @@ import ( "context" "fmt" "os" - "time" + "time" xendit "github.com/xendit/xendit-go/v3" invoice "github.com/xendit/xendit-go/v3/invoice" ) @@ -241,51 +279,35 @@ func main() { } ``` -### Path Parameters - - +## `ExpireInvoice()` Function -### Other Parameters - -Other parameters are passed through a pointer to a apiGetInvoicesRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| Business ID of the sub-account merchant (XP feature) | | -| **externalId** |**string**| | | -| **statuses** |[**InvoiceStatus[]**](invoice/InvoiceStatus.md)| | | -| **limit** |**float32**| | | -| **createdAfter** |**time.Time**| | | -| **createdBefore** |**time.Time**| | | -| **paidAfter** |**time.Time**| | | -| **paidBefore** |**time.Time**| | | -| **expiredAfter** |**time.Time**| | | -| **expiredBefore** |**time.Time**| | | -| **lastInvoice** |**string**| | | -| **clientTypes** |[**InvoiceClientType[]**](invoice/InvoiceClientType.md)| | | -| **paymentChannels** |**string[]**| | | -| **onDemandLink** |**string**| | | -| **recurringPaymentId** |**string**| | | - -### Return type +Manually expire an invoice -[**[]Invoice**](invoice/Invoice.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `ExpireInvoice` | +| Path Parameters | [ExpireInvoicePathParams](#request-parameters--ExpireInvoicePathParams) | +| Request Parameters | [ExpireInvoiceRequestParams](#request-parameters--ExpireInvoiceRequestParams) | +| Return Type | [**Invoice**](invoice/Invoice.md) | -### HTTP request headers +### Path Parameters - ExpireInvoicePathParams -- **Content-Type**: Not defined -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **invoiceId** | **string** | Invoice ID to be expired | ☑️ | | +### Request Parameters - ExpireInvoiceRequestParams -## ExpireInvoice +Parameters that are passed through a pointer to a apiExpireInvoiceRequest struct via the builder pattern -Manually expire an invoice +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -325,33 +347,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **invoiceId** | **string** | Invoice ID to be expired | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiExpireInvoiceRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| Business ID of the sub-account merchant (XP feature) | | - -### Return type - -[**Invoice**](invoice/Invoice.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodApi.md b/docs/PaymentMethodApi.md index 7d903dcf..512a452b 100644 --- a/docs/PaymentMethodApi.md +++ b/docs/PaymentMethodApi.md @@ -1,27 +1,66 @@ -# xendit\PaymentMethodApi +# PaymentMethodApi + + +You can use the APIs below to interface with Xendit's `PaymentMethodApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreatePaymentMethod**](PaymentMethodApi.md#CreatePaymentMethod) | **Post** /v2/payment_methods | Creates payment method | -| [**GetPaymentMethodByID**](PaymentMethodApi.md#GetPaymentMethodByID) | **Get** /v2/payment_methods/{paymentMethodId} | Get payment method by ID | -| [**GetPaymentsByPaymentMethodId**](PaymentMethodApi.md#GetPaymentsByPaymentMethodId) | **Get** /v2/payment_methods/{paymentMethodId}/payments | Returns payments with matching PaymentMethodID. | -| [**PatchPaymentMethod**](PaymentMethodApi.md#PatchPaymentMethod) | **Patch** /v2/payment_methods/{paymentMethodId} | Patch payment methods | -| [**GetAllPaymentMethods**](PaymentMethodApi.md#GetAllPaymentMethods) | **Get** /v2/payment_methods | Get all payment methods by filters | -| [**ExpirePaymentMethod**](PaymentMethodApi.md#ExpirePaymentMethod) | **Post** /v2/payment_methods/{paymentMethodId}/expire | Expires a payment method | -| [**AuthPaymentMethod**](PaymentMethodApi.md#AuthPaymentMethod) | **Post** /v2/payment_methods/{paymentMethodId}/auth | Validate a payment method's linking OTP | -| [**SimulatePayment**](PaymentMethodApi.md#SimulatePayment) | **Post** /v2/payment_methods/{paymentMethodId}/payments/simulate | Makes payment with matching PaymentMethodID. | +| [**CreatePaymentMethod**](PaymentMethodApi.md#createpaymentmethod-function) | **Post** /v2/payment_methods | Creates payment method | +| [**GetPaymentMethodByID**](PaymentMethodApi.md#getpaymentmethodbyid-function) | **Get** /v2/payment_methods/{paymentMethodId} | Get payment method by ID | +| [**GetPaymentsByPaymentMethodId**](PaymentMethodApi.md#getpaymentsbypaymentmethodid-function) | **Get** /v2/payment_methods/{paymentMethodId}/payments | Returns payments with matching PaymentMethodID. | +| [**PatchPaymentMethod**](PaymentMethodApi.md#patchpaymentmethod-function) | **Patch** /v2/payment_methods/{paymentMethodId} | Patch payment methods | +| [**GetAllPaymentMethods**](PaymentMethodApi.md#getallpaymentmethods-function) | **Get** /v2/payment_methods | Get all payment methods by filters | +| [**ExpirePaymentMethod**](PaymentMethodApi.md#expirepaymentmethod-function) | **Post** /v2/payment_methods/{paymentMethodId}/expire | Expires a payment method | +| [**AuthPaymentMethod**](PaymentMethodApi.md#authpaymentmethod-function) | **Post** /v2/payment_methods/{paymentMethodId}/auth | Validate a payment method's linking OTP | +| [**SimulatePayment**](PaymentMethodApi.md#simulatepayment-function) | **Post** /v2/payment_methods/{paymentMethodId}/payments/simulate | Makes payment with matching PaymentMethodID. | -## CreatePaymentMethod +## `CreatePaymentMethod()` Function Creates payment method -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreatePaymentMethod` | +| Path Parameters | [CreatePaymentMethodPathParams](#request-parameters--CreatePaymentMethodPathParams) | +| Request Parameters | [CreatePaymentMethodRequestParams](#request-parameters--CreatePaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | + +### Path Parameters - CreatePaymentMethodPathParams +This endpoint does not need any path parameter. + + +### Request Parameters - CreatePaymentMethodRequestParams + +Parameters that are passed through a pointer to a apiCreatePaymentMethodRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **paymentMethodParameters** |[**PaymentMethodParameters**](payment_method/PaymentMethodParameters.md)| | | + +### Usage Example ```go package main @@ -36,7 +75,7 @@ import ( func main() { - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentMethodParameters := *payment_method.NewPaymentMethodParameters(payment_method.PaymentMethodType("CARD"), payment_method.PaymentMethodReusability("MULTIPLE_USE")) // [OPTIONAL] | PaymentMethodParameters @@ -60,40 +99,37 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiCreatePaymentMethodRequest struct via the builder pattern +## `GetPaymentMethodByID()` Function +Get payment method by ID -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| | | -| **paymentMethodParameters** |[**PaymentMethodParameters**](payment_method/PaymentMethodParameters.md)| | | - -### Return type - -[**PaymentMethod**](payment_method/PaymentMethod.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPaymentMethodByID` | +| Path Parameters | [GetPaymentMethodByIDPathParams](#request-parameters--GetPaymentMethodByIDPathParams) | +| Request Parameters | [GetPaymentMethodByIDRequestParams](#request-parameters--GetPaymentMethodByIDRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetPaymentMethodByIDPathParams -## GetPaymentMethodByID +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -Get payment method by ID +### Request Parameters - GetPaymentMethodByIDRequestParams +Parameters that are passed through a pointer to a apiGetPaymentMethodByIDRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -110,7 +146,7 @@ func main() { paymentMethodId := "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string xenditClient := xendit.NewClient("API-KEY") @@ -131,44 +167,49 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | +## `GetPaymentsByPaymentMethodId()` Function -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPaymentMethodByIDRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | - -### Return type +Returns payments with matching PaymentMethodID. -[**PaymentMethod**](payment_method/PaymentMethod.md) -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPaymentsByPaymentMethodId` | +| Path Parameters | [GetPaymentsByPaymentMethodIdPathParams](#request-parameters--GetPaymentsByPaymentMethodIdPathParams) | +| Request Parameters | [GetPaymentsByPaymentMethodIdRequestParams](#request-parameters--GetPaymentsByPaymentMethodIdRequestParams) | +| Return Type | **map[string]interface{}** | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetPaymentsByPaymentMethodIdPathParams -## GetPaymentsByPaymentMethodId +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -Returns payments with matching PaymentMethodID. +### Request Parameters - GetPaymentsByPaymentMethodIdRequestParams +Parameters that are passed through a pointer to a apiGetPaymentsByPaymentMethodIdRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **paymentRequestId** |**string[]**| | | +| **paymentMethodId2** |**string[]**| | | +| **referenceId** |**string[]**| | | +| **paymentMethodType** |[**PaymentMethodType[]**](payment_method/PaymentMethodType.md)| | | +| **channelCode** |**string[]**| | | +| **status** |**string[]**| | | +| **currency** |**string[]**| | | +| **createdGte** |**time.Time**| | | +| **createdLte** |**time.Time**| | | +| **updatedGte** |**time.Time**| | | +| **updatedLte** |**time.Time**| | | +| **limit** |**int32**| | | -### Example +### Usage Example ```go package main @@ -177,7 +218,7 @@ import ( "context" "fmt" "os" - "time" + "time" xendit "github.com/xendit/xendit-go/v3" payment_method "github.com/xendit/xendit-go/v3/payment_method" ) @@ -186,7 +227,7 @@ func main() { paymentMethodId := "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentRequestId := []string{"Inner_example"} // [OPTIONAL] | []string @@ -243,56 +284,38 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPaymentsByPaymentMethodIdRequest struct via the builder pattern +## `PatchPaymentMethod()` Function +Patch payment methods -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **paymentRequestId** |**string[]**| | | -| **paymentMethodId2** |**string[]**| | | -| **referenceId** |**string[]**| | | -| **paymentMethodType** |[**PaymentMethodType[]**](payment_method/PaymentMethodType.md)| | | -| **channelCode** |**string[]**| | | -| **status** |**string[]**| | | -| **currency** |**string[]**| | | -| **createdGte** |**time.Time**| | | -| **createdLte** |**time.Time**| | | -| **updatedGte** |**time.Time**| | | -| **updatedLte** |**time.Time**| | | -| **limit** |**int32**| | | - -### Return type -**map[string]interface{}** -### HTTP request headers +| Name | Value | +|--------------------|:-------------:| +| Function Name | `PatchPaymentMethod` | +| Path Parameters | [PatchPaymentMethodPathParams](#request-parameters--PatchPaymentMethodPathParams) | +| Request Parameters | [PatchPaymentMethodRequestParams](#request-parameters--PatchPaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -- **Content-Type**: Not defined -- **Accept**: application/json +### Path Parameters - PatchPaymentMethodPathParams -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -## PatchPaymentMethod - -Patch payment methods +### Request Parameters - PatchPaymentMethodRequestParams +Parameters that are passed through a pointer to a apiPatchPaymentMethodRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **paymentMethodUpdateParameters** |[**PaymentMethodUpdateParameters**](payment_method/PaymentMethodUpdateParameters.md)| | | -### Example +### Usage Example ```go package main @@ -309,7 +332,7 @@ func main() { paymentMethodId := "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentMethodUpdateParameters := *payment_method.NewPaymentMethodUpdateParameters() // [OPTIONAL] | PaymentMethodUpdateParameters @@ -333,45 +356,41 @@ func main() { } ``` -### Path Parameters +## `GetAllPaymentMethods()` Function +Get all payment methods by filters -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiPatchPaymentMethodRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **paymentMethodUpdateParameters** |[**PaymentMethodUpdateParameters**](payment_method/PaymentMethodUpdateParameters.md)| | | - -### Return type - -[**PaymentMethod**](payment_method/PaymentMethod.md) - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetAllPaymentMethods` | +| Path Parameters | [GetAllPaymentMethodsPathParams](#request-parameters--GetAllPaymentMethodsPathParams) | +| Request Parameters | [GetAllPaymentMethodsRequestParams](#request-parameters--GetAllPaymentMethodsRequestParams) | +| Return Type | [**PaymentMethodList**](payment_method/PaymentMethodList.md) | +### Path Parameters - GetAllPaymentMethodsPathParams +This endpoint does not need any path parameter. -## GetAllPaymentMethods -Get all payment methods by filters +### Request Parameters - GetAllPaymentMethodsRequestParams +Parameters that are passed through a pointer to a apiGetAllPaymentMethodsRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **id** |**string[]**| | | +| **type_** |**string[]**| | | +| **status** |[**PaymentMethodStatus[]**](payment_method/PaymentMethodStatus.md)| | | +| **reusability** |[**PaymentMethodReusability**](payment_method/PaymentMethodReusabilitypayment_method/.md)| | | +| **customerId** |**string**| | | +| **referenceId** |**string**| | | +| **afterId** |**string**| | | +| **beforeId** |**string**| | | +| **limit** |**int32**| | | -### Example +### Usage Example ```go package main @@ -386,7 +405,7 @@ import ( func main() { - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string id := []string{"Inner_example"} // [OPTIONAL] | []string @@ -434,48 +453,38 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetAllPaymentMethodsRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| | | -| **id** |**string[]**| | | -| **type_** |**string[]**| | | -| **status** |[**PaymentMethodStatus[]**](payment_method/PaymentMethodStatus.md)| | | -| **reusability** |[**PaymentMethodReusability**](payment_method/PaymentMethodReusabilitypayment_method/.md)| | | -| **customerId** |**string**| | | -| **referenceId** |**string**| | | -| **afterId** |**string**| | | -| **beforeId** |**string**| | | -| **limit** |**int32**| | | +## `ExpirePaymentMethod()` Function -### Return type +Expires a payment method -[**PaymentMethodList**](payment_method/PaymentMethodList.md) -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `ExpirePaymentMethod` | +| Path Parameters | [ExpirePaymentMethodPathParams](#request-parameters--ExpirePaymentMethodPathParams) | +| Request Parameters | [ExpirePaymentMethodRequestParams](#request-parameters--ExpirePaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - ExpirePaymentMethodPathParams -## ExpirePaymentMethod +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -Expires a payment method +### Request Parameters - ExpirePaymentMethodRequestParams +Parameters that are passed through a pointer to a apiExpirePaymentMethodRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **paymentMethodExpireParameters** |[**PaymentMethodExpireParameters**](payment_method/PaymentMethodExpireParameters.md)| | | -### Example +### Usage Example ```go package main @@ -492,7 +501,7 @@ func main() { paymentMethodId := "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentMethodExpireParameters := *payment_method.NewPaymentMethodExpireParameters() // [OPTIONAL] | PaymentMethodExpireParameters @@ -516,45 +525,38 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiExpirePaymentMethodRequest struct via the builder pattern - +## `AuthPaymentMethod()` Function -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **paymentMethodExpireParameters** |[**PaymentMethodExpireParameters**](payment_method/PaymentMethodExpireParameters.md)| | | - -### Return type +Validate a payment method's linking OTP -[**PaymentMethod**](payment_method/PaymentMethod.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `AuthPaymentMethod` | +| Path Parameters | [AuthPaymentMethodPathParams](#request-parameters--AuthPaymentMethodPathParams) | +| Request Parameters | [AuthPaymentMethodRequestParams](#request-parameters--AuthPaymentMethodRequestParams) | +| Return Type | [**PaymentMethod**](payment_method/PaymentMethod.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - AuthPaymentMethodPathParams -## AuthPaymentMethod +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -Validate a payment method's linking OTP +### Request Parameters - AuthPaymentMethodRequestParams +Parameters that are passed through a pointer to a apiAuthPaymentMethodRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **paymentMethodAuthParameters** |[**PaymentMethodAuthParameters**](payment_method/PaymentMethodAuthParameters.md)| | | -### Example +### Usage Example ```go package main @@ -571,7 +573,7 @@ func main() { paymentMethodId := "pm-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentMethodAuthParameters := *payment_method.NewPaymentMethodAuthParameters("AuthCode_example") // [OPTIONAL] | PaymentMethodAuthParameters @@ -595,45 +597,37 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiAuthPaymentMethodRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **paymentMethodAuthParameters** |[**PaymentMethodAuthParameters**](payment_method/PaymentMethodAuthParameters.md)| | | +## `SimulatePayment()` Function -### Return type +Makes payment with matching PaymentMethodID. -[**PaymentMethod**](payment_method/PaymentMethod.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `SimulatePayment` | +| Path Parameters | [SimulatePaymentPathParams](#request-parameters--SimulatePaymentPathParams) | +| Request Parameters | [SimulatePaymentRequestParams](#request-parameters--SimulatePaymentRequestParams) | +| Return Type | (empty response body) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - SimulatePaymentPathParams -## SimulatePayment +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentMethodId** | **string** | | ☑️ | | -Makes payment with matching PaymentMethodID. +### Request Parameters - SimulatePaymentRequestParams +Parameters that are passed through a pointer to a apiSimulatePaymentRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **simulatePaymentRequest** |[**SimulatePaymentRequest**](payment_method/SimulatePaymentRequest.md)| | | -### Example +### Usage Example ```go package main @@ -669,33 +663,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentMethodId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiSimulatePaymentRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **simulatePaymentRequest** |[**SimulatePaymentRequest**](payment_method/SimulatePaymentRequest.md)| | | - -### Return type - - (empty response body) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/PaymentRequestApi.md b/docs/PaymentRequestApi.md index 8b64f977..d892f7f9 100644 --- a/docs/PaymentRequestApi.md +++ b/docs/PaymentRequestApi.md @@ -1,26 +1,66 @@ -# xendit\PaymentRequestApi +# PaymentRequestApi + + +You can use the APIs below to interface with Xendit's `PaymentRequestApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreatePaymentRequest**](PaymentRequestApi.md#CreatePaymentRequest) | **Post** /payment_requests | Create Payment Request | -| [**GetPaymentRequestByID**](PaymentRequestApi.md#GetPaymentRequestByID) | **Get** /payment_requests/{paymentRequestId} | Get payment request by ID | -| [**GetPaymentRequestCaptures**](PaymentRequestApi.md#GetPaymentRequestCaptures) | **Get** /payment_requests/{paymentRequestId}/captures | Get Payment Request Capture | -| [**GetAllPaymentRequests**](PaymentRequestApi.md#GetAllPaymentRequests) | **Get** /payment_requests | Get all payment requests by filter | -| [**CapturePaymentRequest**](PaymentRequestApi.md#CapturePaymentRequest) | **Post** /payment_requests/{paymentRequestId}/captures | Payment Request Capture | -| [**AuthorizePaymentRequest**](PaymentRequestApi.md#AuthorizePaymentRequest) | **Post** /payment_requests/{paymentRequestId}/auth | Payment Request Authorize | -| [**ResendPaymentRequestAuth**](PaymentRequestApi.md#ResendPaymentRequestAuth) | **Post** /payment_requests/{paymentRequestId}/auth/resend | Payment Request Resend Auth | +| [**CreatePaymentRequest**](PaymentRequestApi.md#createpaymentrequest-function) | **Post** /payment_requests | Create Payment Request | +| [**GetPaymentRequestByID**](PaymentRequestApi.md#getpaymentrequestbyid-function) | **Get** /payment_requests/{paymentRequestId} | Get payment request by ID | +| [**GetPaymentRequestCaptures**](PaymentRequestApi.md#getpaymentrequestcaptures-function) | **Get** /payment_requests/{paymentRequestId}/captures | Get Payment Request Capture | +| [**GetAllPaymentRequests**](PaymentRequestApi.md#getallpaymentrequests-function) | **Get** /payment_requests | Get all payment requests by filter | +| [**CapturePaymentRequest**](PaymentRequestApi.md#capturepaymentrequest-function) | **Post** /payment_requests/{paymentRequestId}/captures | Payment Request Capture | +| [**AuthorizePaymentRequest**](PaymentRequestApi.md#authorizepaymentrequest-function) | **Post** /payment_requests/{paymentRequestId}/auth | Payment Request Authorize | +| [**ResendPaymentRequestAuth**](PaymentRequestApi.md#resendpaymentrequestauth-function) | **Post** /payment_requests/{paymentRequestId}/auth/resend | Payment Request Resend Auth | -## CreatePaymentRequest +## `CreatePaymentRequest()` Function Create Payment Request -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreatePaymentRequest` | +| Path Parameters | [CreatePaymentRequestPathParams](#request-parameters--CreatePaymentRequestPathParams) | +| Request Parameters | [CreatePaymentRequestRequestParams](#request-parameters--CreatePaymentRequestRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | + +### Path Parameters - CreatePaymentRequestPathParams +This endpoint does not need any path parameter. + + +### Request Parameters - CreatePaymentRequestRequestParams + +Parameters that are passed through a pointer to a apiCreatePaymentRequestRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotencyKey** |**string**| | | +| **forUserId** |**string**| | | +| **paymentRequestParameters** |[**PaymentRequestParameters**](payment_request/PaymentRequestParameters.md)| | | + +### Usage Example ```go package main @@ -37,7 +77,7 @@ func main() { idempotencyKey := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentRequestParameters := *payment_request.NewPaymentRequestParameters(payment_request.PaymentRequestCurrency("IDR")) // [OPTIONAL] | PaymentRequestParameters @@ -62,41 +102,37 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiCreatePaymentRequestRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **idempotencyKey** |**string**| | | -| **forUserId** |**string**| | | -| **paymentRequestParameters** |[**PaymentRequestParameters**](payment_request/PaymentRequestParameters.md)| | | +## `GetPaymentRequestByID()` Function -### Return type +Get payment request by ID -[**PaymentRequest**](payment_request/PaymentRequest.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPaymentRequestByID` | +| Path Parameters | [GetPaymentRequestByIDPathParams](#request-parameters--GetPaymentRequestByIDPathParams) | +| Request Parameters | [GetPaymentRequestByIDRequestParams](#request-parameters--GetPaymentRequestByIDRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetPaymentRequestByIDPathParams -## GetPaymentRequestByID +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentRequestId** | **string** | | ☑️ | | -Get payment request by ID +### Request Parameters - GetPaymentRequestByIDRequestParams +Parameters that are passed through a pointer to a apiGetPaymentRequestByIDRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -113,7 +149,7 @@ func main() { paymentRequestId := "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string xenditClient := xendit.NewClient("API-KEY") @@ -134,44 +170,38 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentRequestId** | **string** | | | - -### Other Parameters +## `GetPaymentRequestCaptures()` Function -Other parameters are passed through a pointer to a apiGetPaymentRequestByIDRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | - -### Return type +Get Payment Request Capture -[**PaymentRequest**](payment_request/PaymentRequest.md) -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPaymentRequestCaptures` | +| Path Parameters | [GetPaymentRequestCapturesPathParams](#request-parameters--GetPaymentRequestCapturesPathParams) | +| Request Parameters | [GetPaymentRequestCapturesRequestParams](#request-parameters--GetPaymentRequestCapturesRequestParams) | +| Return Type | [**CaptureListResponse**](payment_request/CaptureListResponse.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - GetPaymentRequestCapturesPathParams -## GetPaymentRequestCaptures +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentRequestId** | **string** | | ☑️ | | -Get Payment Request Capture +### Request Parameters - GetPaymentRequestCapturesRequestParams +Parameters that are passed through a pointer to a apiGetPaymentRequestCapturesRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **limit** |**int32**| | | -### Example +### Usage Example ```go package main @@ -188,7 +218,7 @@ func main() { paymentRequestId := "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string limit := int32(56) // [OPTIONAL] | int32 @@ -212,45 +242,38 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentRequestId** | **string** | | | +## `GetAllPaymentRequests()` Function -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPaymentRequestCapturesRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **limit** |**int32**| | | - -### Return type - -[**CaptureListResponse**](payment_request/CaptureListResponse.md) +Get all payment requests by filter -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetAllPaymentRequests` | +| Path Parameters | [GetAllPaymentRequestsPathParams](#request-parameters--GetAllPaymentRequestsPathParams) | +| Request Parameters | [GetAllPaymentRequestsRequestParams](#request-parameters--GetAllPaymentRequestsRequestParams) | +| Return Type | [**PaymentRequestListResponse**](payment_request/PaymentRequestListResponse.md) | +### Path Parameters - GetAllPaymentRequestsPathParams +This endpoint does not need any path parameter. -## GetAllPaymentRequests -Get all payment requests by filter +### Request Parameters - GetAllPaymentRequestsRequestParams +Parameters that are passed through a pointer to a apiGetAllPaymentRequestsRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **referenceId** |**string[]**| | | +| **id** |**string[]**| | | +| **customerId** |**string[]**| | | +| **limit** |**int32**| | | +| **beforeId** |**string**| | | +| **afterId** |**string**| | | -### Example +### Usage Example ```go package main @@ -265,7 +288,7 @@ import ( func main() { - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string referenceId := []string{"Inner_example"} // [OPTIONAL] | []string @@ -304,45 +327,38 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetAllPaymentRequestsRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| | | -| **referenceId** |**string[]**| | | -| **id** |**string[]**| | | -| **customerId** |**string[]**| | | -| **limit** |**int32**| | | -| **beforeId** |**string**| | | -| **afterId** |**string**| | | +## `CapturePaymentRequest()` Function -### Return type +Payment Request Capture -[**PaymentRequestListResponse**](payment_request/PaymentRequestListResponse.md) -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CapturePaymentRequest` | +| Path Parameters | [CapturePaymentRequestPathParams](#request-parameters--CapturePaymentRequestPathParams) | +| Request Parameters | [CapturePaymentRequestRequestParams](#request-parameters--CapturePaymentRequestRequestParams) | +| Return Type | [**Capture**](payment_request/Capture.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - CapturePaymentRequestPathParams -## CapturePaymentRequest +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentRequestId** | **string** | | ☑️ | | -Payment Request Capture +### Request Parameters - CapturePaymentRequestRequestParams +Parameters that are passed through a pointer to a apiCapturePaymentRequestRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **captureParameters** |[**CaptureParameters**](payment_request/CaptureParameters.md)| | | -### Example +### Usage Example ```go package main @@ -359,7 +375,7 @@ func main() { paymentRequestId := "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string captureParameters := *payment_request.NewCaptureParameters(float64(123)) // [OPTIONAL] | CaptureParameters @@ -383,45 +399,38 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentRequestId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiCapturePaymentRequestRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **captureParameters** |[**CaptureParameters**](payment_request/CaptureParameters.md)| | | +## `AuthorizePaymentRequest()` Function -### Return type +Payment Request Authorize -[**Capture**](payment_request/Capture.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `AuthorizePaymentRequest` | +| Path Parameters | [AuthorizePaymentRequestPathParams](#request-parameters--AuthorizePaymentRequestPathParams) | +| Request Parameters | [AuthorizePaymentRequestRequestParams](#request-parameters--AuthorizePaymentRequestRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - AuthorizePaymentRequestPathParams -## AuthorizePaymentRequest +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentRequestId** | **string** | | ☑️ | | -Payment Request Authorize +### Request Parameters - AuthorizePaymentRequestRequestParams +Parameters that are passed through a pointer to a apiAuthorizePaymentRequestRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | +| **paymentRequestAuthParameters** |[**PaymentRequestAuthParameters**](payment_request/PaymentRequestAuthParameters.md)| | | -### Example +### Usage Example ```go package main @@ -438,7 +447,7 @@ func main() { paymentRequestId := "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string paymentRequestAuthParameters := *payment_request.NewPaymentRequestAuthParameters("AuthCode_example") // [OPTIONAL] | PaymentRequestAuthParameters @@ -462,45 +471,37 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentRequestId** | **string** | | | - -### Other Parameters +## `ResendPaymentRequestAuth()` Function -Other parameters are passed through a pointer to a apiAuthorizePaymentRequestRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | -| **paymentRequestAuthParameters** |[**PaymentRequestAuthParameters**](payment_request/PaymentRequestAuthParameters.md)| | | - -### Return type +Payment Request Resend Auth -[**PaymentRequest**](payment_request/PaymentRequest.md) -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json +| Name | Value | +|--------------------|:-------------:| +| Function Name | `ResendPaymentRequestAuth` | +| Path Parameters | [ResendPaymentRequestAuthPathParams](#request-parameters--ResendPaymentRequestAuthPathParams) | +| Request Parameters | [ResendPaymentRequestAuthRequestParams](#request-parameters--ResendPaymentRequestAuthRequestParams) | +| Return Type | [**PaymentRequest**](payment_request/PaymentRequest.md) | -[[Back to top]](#) -[[Back to README]](../README.md) +### Path Parameters - ResendPaymentRequestAuthPathParams -## ResendPaymentRequestAuth +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **paymentRequestId** | **string** | | ☑️ | | -Payment Request Resend Auth +### Request Parameters - ResendPaymentRequestAuthRequestParams +Parameters that are passed through a pointer to a apiResendPaymentRequestAuthRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -517,7 +518,7 @@ func main() { paymentRequestId := "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822" // [REQUIRED] | string - forUserId := "5f9a3fbd571a1c4068aa40ce" // [OPTIONAL] | string + forUserId := "5f9a3fbd571a1c4068aa40cf" // [OPTIONAL] | string xenditClient := xendit.NewClient("API-KEY") @@ -538,33 +539,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **paymentRequestId** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiResendPaymentRequestAuthRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| | | - -### Return type - -[**PaymentRequest**](payment_request/PaymentRequest.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/PayoutApi.md b/docs/PayoutApi.md index 4ce2fd59..76b3e5bb 100644 --- a/docs/PayoutApi.md +++ b/docs/PayoutApi.md @@ -1,22 +1,62 @@ -# xendit\PayoutApi +# PayoutApi + + +You can use the APIs below to interface with Xendit's `PayoutApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreatePayout**](PayoutApi.md#CreatePayout) | **Post** /v2/payouts | API to send money at scale to bank accounts & eWallets | -| [**GetPayoutById**](PayoutApi.md#GetPayoutById) | **Get** /v2/payouts/{id} | API to fetch the current status, or details of the payout | -| [**GetPayoutChannels**](PayoutApi.md#GetPayoutChannels) | **Get** /payouts_channels | API providing the current list of banks and e-wallets we support for payouts for both regions | -| [**GetPayouts**](PayoutApi.md#GetPayouts) | **Get** /v2/payouts | API to retrieve all matching payouts with reference ID | -| [**CancelPayout**](PayoutApi.md#CancelPayout) | **Post** /v2/payouts/{id}/cancel | API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. | +| [**CreatePayout**](PayoutApi.md#createpayout-function) | **Post** /v2/payouts | API to send money at scale to bank accounts & eWallets | +| [**GetPayoutById**](PayoutApi.md#getpayoutbyid-function) | **Get** /v2/payouts/{id} | API to fetch the current status, or details of the payout | +| [**GetPayoutChannels**](PayoutApi.md#getpayoutchannels-function) | **Get** /payouts_channels | API providing the current list of banks and e-wallets we support for payouts for both regions | +| [**GetPayouts**](PayoutApi.md#getpayouts-function) | **Get** /v2/payouts | API to retrieve all matching payouts with reference ID | +| [**CancelPayout**](PayoutApi.md#cancelpayout-function) | **Post** /v2/payouts/{id}/cancel | API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. | -## CreatePayout +## `CreatePayout()` Function API to send money at scale to bank accounts & eWallets -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreatePayout` | +| Path Parameters | [CreatePayoutPathParams](#request-parameters--CreatePayoutPathParams) | +| Request Parameters | [CreatePayoutRequestParams](#request-parameters--CreatePayoutRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | + +### Path Parameters - CreatePayoutPathParams +This endpoint does not need any path parameter. + + +### Request Parameters - CreatePayoutRequestParams + +Parameters that are passed through a pointer to a apiCreatePayoutRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotencyKey** |**string**| ☑️ | | +| **forUserId** |**string**| | | +| **createPayoutRequest** |[**CreatePayoutRequest**](payout/CreatePayoutRequest.md)| | | + +### Usage Example ```go package main @@ -63,39 +103,35 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiCreatePayoutRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **idempotencyKey** |**string**| A unique key to prevent duplicate requests from pushing through our system. No expiration. | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | | -| **createPayoutRequest** |[**CreatePayoutRequest**](payout/CreatePayoutRequest.md)| | | +## `GetPayoutById()` Function -### Return type +API to fetch the current status, or details of the payout -[**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPayoutById` | +| Path Parameters | [GetPayoutByIdPathParams](#request-parameters--GetPayoutByIdPathParams) | +| Request Parameters | [GetPayoutByIdRequestParams](#request-parameters--GetPayoutByIdRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | -### HTTP request headers +### Path Parameters - GetPayoutByIdPathParams -- **Content-Type**: application/json -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **id** | **string** | Payout id returned from the response of /v2/payouts | ☑️ | | +### Request Parameters - GetPayoutByIdRequestParams -## GetPayoutById +Parameters that are passed through a pointer to a apiGetPayoutByIdRequest struct via the builder pattern -API to fetch the current status, or details of the payout +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -137,42 +173,33 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **id** | **string** | Payout id returned from the response of /v2/payouts | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPayoutByIdRequest struct via the builder pattern - +## `GetPayoutChannels()` Function -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | | - -### Return type - -[**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) +API providing the current list of banks and e-wallets we support for payouts for both regions -### HTTP request headers +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPayoutChannels` | +| Path Parameters | [GetPayoutChannelsPathParams](#request-parameters--GetPayoutChannelsPathParams) | +| Request Parameters | [GetPayoutChannelsRequestParams](#request-parameters--GetPayoutChannelsRequestParams) | +| Return Type | [**[]Channel**](payout/Channel.md) | -- **Content-Type**: Not defined -- **Accept**: application/json +### Path Parameters - GetPayoutChannelsPathParams +This endpoint does not need any path parameter. -[[Back to top]](#) -[[Back to README]](../README.md) +### Request Parameters - GetPayoutChannelsRequestParams -## GetPayoutChannels +Parameters that are passed through a pointer to a apiGetPayoutChannelsRequest struct via the builder pattern -API providing the current list of banks and e-wallets we support for payouts for both regions +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **currency** |**string**| | | +| **channelCategory** |[**ChannelCategory[]**](payout/ChannelCategory.md)| | | +| **channelCode** |**string**| | | +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -223,40 +250,34 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPayoutChannelsRequest struct via the builder pattern +## `GetPayouts()` Function +API to retrieve all matching payouts with reference ID -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **currency** |**string**| Filter channels by currency from ISO-4217 values | | -| **channelCategory** |[**ChannelCategory[]**](payout/ChannelCategory.md)| Filter channels by category | | -| **channelCode** |**string**| Filter channels by channel code, prefixed by ISO-3166 country code | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | | - -### Return type - -[**[]Channel**](payout/Channel.md) - -### HTTP request headers +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetPayouts` | +| Path Parameters | [GetPayoutsPathParams](#request-parameters--GetPayoutsPathParams) | +| Request Parameters | [GetPayoutsRequestParams](#request-parameters--GetPayoutsRequestParams) | +| Return Type | [**GetPayouts200Response**](payout/GetPayouts200Response.md) | -- **Content-Type**: Not defined -- **Accept**: application/json +### Path Parameters - GetPayoutsPathParams +This endpoint does not need any path parameter. -[[Back to top]](#) -[[Back to README]](../README.md) +### Request Parameters - GetPayoutsRequestParams -## GetPayouts +Parameters that are passed through a pointer to a apiGetPayoutsRequest struct via the builder pattern -API to retrieve all matching payouts with reference ID +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **referenceId** |**string**| ☑️ | | +| **limit** |**float32**| | | +| **afterId** |**string**| | | +| **beforeId** |**string**| | | +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -311,41 +332,35 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetPayoutsRequest struct via the builder pattern +## `CancelPayout()` Function +API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **referenceId** |**string**| Reference_id provided when creating the payout | | -| **limit** |**float32**| Number of records to fetch per API call | | -| **afterId** |**string**| Used to fetch record after this payout unique id | | -| **beforeId** |**string**| Used to fetch record before this payout unique id | | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | | - -### Return type +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CancelPayout` | +| Path Parameters | [CancelPayoutPathParams](#request-parameters--CancelPayoutPathParams) | +| Request Parameters | [CancelPayoutRequestParams](#request-parameters--CancelPayoutRequestParams) | +| Return Type | [**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) | -[**GetPayouts200Response**](payout/GetPayouts200Response.md) +### Path Parameters - CancelPayoutPathParams -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **id** | **string** | Payout id returned from the response of /v2/payouts | ☑️ | | -[[Back to top]](#) -[[Back to README]](../README.md) +### Request Parameters - CancelPayoutRequestParams +Parameters that are passed through a pointer to a apiCancelPayoutRequest struct via the builder pattern -## CancelPayout - -API to cancel requested payouts that have not yet been sent to partner banks and e-wallets. Cancellation is possible if the payout has not been sent out via our partner and when payout status is ACCEPTED. +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -387,33 +402,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **id** | **string** | Payout id returned from the response of /v2/payouts | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiCancelPayoutRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information. | | - -### Return type - -[**GetPayouts200ResponseDataInner**](payout/GetPayouts200ResponseDataInner.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/RefundApi.md b/docs/RefundApi.md index 2e0d591c..6b66d906 100644 --- a/docs/RefundApi.md +++ b/docs/RefundApi.md @@ -1,21 +1,61 @@ -# xendit\RefundApi +# RefundApi + + +You can use the APIs below to interface with Xendit's `RefundApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**CreateRefund**](RefundApi.md#CreateRefund) | **Post** /refunds | | -| [**GetRefund**](RefundApi.md#GetRefund) | **Get** /refunds/{refundID} | | -| [**GetAllRefunds**](RefundApi.md#GetAllRefunds) | **Get** /refunds | | -| [**CancelRefund**](RefundApi.md#CancelRefund) | **Post** /refunds/{refundID}/cancel | | +| [**CreateRefund**](RefundApi.md#createrefund-function) | **Post** /refunds | | +| [**GetRefund**](RefundApi.md#getrefund-function) | **Get** /refunds/{refundID} | | +| [**GetAllRefunds**](RefundApi.md#getallrefunds-function) | **Get** /refunds | | +| [**CancelRefund**](RefundApi.md#cancelrefund-function) | **Post** /refunds/{refundID}/cancel | | + + + +## `CreateRefund()` Function + + + +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CreateRefund` | +| Path Parameters | [CreateRefundPathParams](#request-parameters--CreateRefundPathParams) | +| Request Parameters | [CreateRefundRequestParams](#request-parameters--CreateRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | +### Path Parameters - CreateRefundPathParams +This endpoint does not need any path parameter. -## CreateRefund +### Request Parameters - CreateRefundRequestParams +Parameters that are passed through a pointer to a apiCreateRefundRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **idempotencyKey** |**string**| | | +| **forUserId** |**string**| | | +| **createRefund** |[**CreateRefund**](refund/CreateRefund.md)| | | -### Example +### Usage Example ```go package main @@ -57,39 +97,36 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters +## `GetRefund()` Function -Other parameters are passed through a pointer to a apiCreateRefundRequest struct via the builder pattern -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **idempotencyKey** |**string**| | | -| **forUserId** |**string**| | | -| **createRefund** |[**CreateRefund**](refund/CreateRefund.md)| | | +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetRefund` | +| Path Parameters | [GetRefundPathParams](#request-parameters--GetRefundPathParams) | +| Request Parameters | [GetRefundRequestParams](#request-parameters--GetRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | -### Return type +### Path Parameters - GetRefundPathParams -[**Refund**](refund/Refund.md) -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **refundID** | **string** | | ☑️ | | +### Request Parameters - GetRefundRequestParams -## GetRefund - +Parameters that are passed through a pointer to a apiGetRefundRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **idempotencyKey** |**string**| | | +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -130,43 +167,37 @@ func main() { } ``` -### Path Parameters +## `GetAllRefunds()` Function -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **refundID** | **string** | | | -### Other Parameters +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetAllRefunds` | +| Path Parameters | [GetAllRefundsPathParams](#request-parameters--GetAllRefundsPathParams) | +| Request Parameters | [GetAllRefundsRequestParams](#request-parameters--GetAllRefundsRequestParams) | +| Return Type | [**RefundList**](refund/RefundList.md) | -Other parameters are passed through a pointer to a apiGetRefundRequest struct via the builder pattern +### Path Parameters - GetAllRefundsPathParams +This endpoint does not need any path parameter. -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **idempotencyKey** |**string**| | | -| **forUserId** |**string**| | | - -### Return type - -[**Refund**](refund/Refund.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) -[[Back to README]](../README.md) - - -## GetAllRefunds +### Request Parameters - GetAllRefundsRequestParams +Parameters that are passed through a pointer to a apiGetAllRefundsRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **paymentRequestId** |**string**| | | +| **invoiceId** |**string**| | | +| **paymentMethodType** |**string**| | | +| **channelCode** |**string**| | | +| **limit** |**float32**| | | +| **afterId** |**string**| | | +| **beforeId** |**string**| | | -### Example +### Usage Example ```go package main @@ -223,44 +254,36 @@ func main() { } ``` -### Path Parameters +## `CancelRefund()` Function -### Other Parameters +| Name | Value | +|--------------------|:-------------:| +| Function Name | `CancelRefund` | +| Path Parameters | [CancelRefundPathParams](#request-parameters--CancelRefundPathParams) | +| Request Parameters | [CancelRefundRequestParams](#request-parameters--CancelRefundRequestParams) | +| Return Type | [**Refund**](refund/Refund.md) | -Other parameters are passed through a pointer to a apiGetAllRefundsRequest struct via the builder pattern +### Path Parameters - CancelRefundPathParams -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| | | -| **paymentRequestId** |**string**| | | -| **invoiceId** |**string**| | | -| **paymentMethodType** |**string**| | | -| **channelCode** |**string**| | | -| **limit** |**float32**| | | -| **afterId** |**string**| | | -| **beforeId** |**string**| | | - -### Return type +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **refundID** | **string** | | ☑️ | | -[**RefundList**](refund/RefundList.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) -[[Back to README]](../README.md) - - -## CancelRefund +### Request Parameters - CancelRefundRequestParams +Parameters that are passed through a pointer to a apiCancelRefundRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **idempotencyKey** |**string**| | | +| **forUserId** |**string**| | | -### Example +### Usage Example ```go package main @@ -301,34 +324,4 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **refundID** | **string** | | | - -### Other Parameters - -Other parameters are passed through a pointer to a apiCancelRefundRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **idempotencyKey** |**string**| | | -| **forUserId** |**string**| | | - -### Return type - -[**Refund**](refund/Refund.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/TransactionApi.md b/docs/TransactionApi.md index a137caef..ea2f3b88 100644 --- a/docs/TransactionApi.md +++ b/docs/TransactionApi.md @@ -1,21 +1,64 @@ -# xendit\TransactionApi +# TransactionApi + + +You can use the APIs below to interface with Xendit's `TransactionApi`. +To start using the API, you need to configure the secret key and initiate the client instance. + +```go +package main + +import ( + "context" + "fmt" + "os" + xendit "github.com/xendit/xendit-go/v3" +) + +func main() { + xenditClient := xendit.NewClient("API-KEY") +} +``` All URIs are relative to *https://api.xendit.co* | Method | HTTP request | Description | | ------------- | ------------- | ------------- | -| [**GetTransactionByID**](TransactionApi.md#GetTransactionByID) | **Get** /transactions/{id} | Get a transaction based on its id | -| [**GetAllTransactions**](TransactionApi.md#GetAllTransactions) | **Get** /transactions | Get a list of transactions | +| [**GetTransactionByID**](TransactionApi.md#gettransactionbyid-function) | **Get** /transactions/{id} | Get a transaction based on its id | +| [**GetAllTransactions**](TransactionApi.md#getalltransactions-function) | **Get** /transactions | Get a list of transactions | -## GetTransactionByID +## `GetTransactionByID()` Function Get a transaction based on its id -### Example +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetTransactionByID` | +| Path Parameters | [GetTransactionByIDPathParams](#request-parameters--GetTransactionByIDPathParams) | +| Request Parameters | [GetTransactionByIDRequestParams](#request-parameters--GetTransactionByIDRequestParams) | +| Return Type | [**TransactionResponse**](balance_and_transaction/TransactionResponse.md) | + +### Path Parameters - GetTransactionByIDPathParams + + +| Name | Type | Description | Required | Default | +| ------------- |:-------------:| ------------- |:-------------:|-------------| +| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| ☑️ | | +| **id** | **string** | | ☑️ | | + +### Request Parameters - GetTransactionByIDRequestParams + +Parameters that are passed through a pointer to a apiGetTransactionByIDRequest struct via the builder pattern + +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| +| **forUserId** |**string**| | | + +### Usage Example ```go package main @@ -56,44 +99,45 @@ func main() { } ``` -### Path Parameters - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | -------------| -| **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.| | -| **id** | **string** | | | +## `GetAllTransactions()` Function -### Other Parameters - -Other parameters are passed through a pointer to a apiGetTransactionByIDRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | | - -### Return type - -[**TransactionResponse**](balance_and_transaction/TransactionResponse.md) +Get a list of transactions -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json -[[Back to top]](#) -[[Back to README]](../README.md) +| Name | Value | +|--------------------|:-------------:| +| Function Name | `GetAllTransactions` | +| Path Parameters | [GetAllTransactionsPathParams](#request-parameters--GetAllTransactionsPathParams) | +| Request Parameters | [GetAllTransactionsRequestParams](#request-parameters--GetAllTransactionsRequestParams) | +| Return Type | [**TransactionsResponse**](balance_and_transaction/TransactionsResponse.md) | +### Path Parameters - GetAllTransactionsPathParams +This endpoint does not need any path parameter. -## GetAllTransactions -Get a list of transactions +### Request Parameters - GetAllTransactionsRequestParams +Parameters that are passed through a pointer to a apiGetAllTransactionsRequest struct via the builder pattern +|Name | Type | Required |Default | +|-------------|:-------------:|:-------------:|-------------| +| **forUserId** |**string**| | | +| **types** |[**TransactionTypes[]**](balance_and_transaction/TransactionTypes.md)| | | +| **statuses** |[**TransactionStatuses[]**](balance_and_transaction/TransactionStatuses.md)| | | +| **channelCategories** |[**ChannelsCategories[]**](balance_and_transaction/ChannelsCategories.md)| | | +| **referenceId** |**string**| | | +| **productId** |**string**| | | +| **accountIdentifier** |**string**| | | +| **amount** |**float32**| | | +| **currency** |[**Currency**](balance_and_transaction/Currencybalance_and_transaction/.md)| | | +| **created** |[**DateRangeFilter**](balance_and_transaction/DateRangeFilterbalance_and_transaction/.md)| | | +| **updated** |[**DateRangeFilter**](balance_and_transaction/DateRangeFilterbalance_and_transaction/.md)| | | +| **limit** |**float32**| | [10] | +| **afterId** |**string**| | | +| **beforeId** |**string**| | | -### Example +### Usage Example ```go package main @@ -188,41 +232,4 @@ func main() { } ``` -### Path Parameters - - - -### Other Parameters - -Other parameters are passed through a pointer to a apiGetAllTransactionsRequest struct via the builder pattern - - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **forUserId** |**string**| The sub-account user-id that you want to make this transaction for. This header is only used if you have access to xenPlatform. See xenPlatform for more information | | -| **types** |[**TransactionTypes[]**](balance_and_transaction/TransactionTypes.md)| Transaction types that will be included in the result. Default is to include all transaction types | | -| **statuses** |[**TransactionStatuses[]**](balance_and_transaction/TransactionStatuses.md)| Status of the transaction. Default is to include all status. | | -| **channelCategories** |[**ChannelsCategories[]**](balance_and_transaction/ChannelsCategories.md)| Payment channels in which the transaction is carried out. Default is to include all channels. | | -| **referenceId** |**string**| To filter the result for transactions with matching reference given (case sensitive) | | -| **productId** |**string**| To filter the result for transactions with matching product_id (a.k.a payment_id) given (case sensitive) | | -| **accountIdentifier** |**string**| Account identifier of transaction. The format will be different from each channel. For example, on `BANK` channel it will be account number and on `CARD` it will be masked card number. | | -| **amount** |**float32**| Specific transaction amount to search for | | -| **currency** |[**Currency**](balance_and_transaction/Currencybalance_and_transaction/.md)| | | -| **created** |[**DateRangeFilter**](balance_and_transaction/DateRangeFilterbalance_and_transaction/.md)| Filter time of transaction by created date. If not specified will list all dates. | | -| **updated** |[**DateRangeFilter**](balance_and_transaction/DateRangeFilterbalance_and_transaction/.md)| Filter time of transaction by updated date. If not specified will list all dates. | | -| **limit** |**float32**| number of items in the result per page. Another name for \"results_per_page\" | [default to 10] | -| **afterId** |**string**| | | -| **beforeId** |**string**| | | - -### Return type - -[**TransactionsResponse**](balance_and_transaction/TransactionsResponse.md) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to README]](../README.md) - diff --git a/docs/balance_and_transaction.yaml b/docs/balance_and_transaction.yaml deleted file mode 100644 index a47247e7..00000000 --- a/docs/balance_and_transaction.yaml +++ /dev/null @@ -1,1054 +0,0 @@ -openapi: 3.0.0 -info: - contact: - email: email@xendit.com - description: "# Introduction\nThis specification describes how to use the Transaction\ - \ Service V4 API. \n\n**Transaction Service** is the service that records the\ - \ customer transactions and is responsible to calculate their balance. All products\ - \ that move customer money around whether it is money-in, money-out, or transfer\ - \ will interact with the Transaction Service on its flow. Transaction Service\ - \ is the source of truth of Xendit and Customer regarding how much money that\ - \ customer has that is stored in Xendit. Transaction Service is the source that\ - \ is used for both our internal and customer financial reconciliation. Internally,\ - \ the Transaction Service data structure is similar to how double-entry accounting\ - \ works.\n\n## How Xendit teams/services do integrate with Transaction Service\ - \ V4\n\n\n**Channel product team/service** They interact with the Transaction\ - \ Service when they want to record the transactions. This transaction can be money-in\ - \ (balance added), money-out (balance deducted), transfer, refund/void/reversal,\ - \ or other kind of transaction that affects customer balance. Product team also\ - \ interacts with the Transaction Service for getting information about the transaction\ - \ or balance.\n\n**Billing/Fee team/service** They interact with Transaction Service\ - \ either as the dependency of Transaction Service for getting the correct fee\ - \ calculation/settings. Or using Transaction Service for getting the transaction/fee\ - \ information to calculate the bill for the customer.\n\n**NUX team/service**\ - \ They interact with the Transaction Service to set up the customer ledger_account\ - \ that is used to record their transactions.\n\n**Finance team/service** They\ - \ interact with the Transaction Service to get the transaction and balance data\ - \ for each customer to do reconciliation.\n\n**Dashboard/API team/service** They\ - \ interact with the Transaction Service as a proxy to show the data to the Customer.\n\ - \n## Prerequisites\n\nBefore staring to use **Transaction Service API** you need\ - \ to complete a few things:\n1. Find out **Base URL** for the API. Every endpoint\ - \ definition in this document contains list of available servers (local, staging,\ - \ production)\n2. Set up ledger accounts using business id and currency. **Ledger\ - \ Account** represents the account of the customer that will be used to associate\ - \ with ledger lines. Each business may have at least 1 ledger account group (a\ - \ group consists of a few accounts of types such as cash, liability, holding),\ - \ and the money movement of their ledger will revolve around those ledger accounts.\ - \ **Ledger Lines** that show a debit or credit transaction for a ledger account.\ - \ We’re using the double-entry principle in accounting where we should post 2\ - \ lines every time we make a transaction, 1 to debit an account and 1 to credit\ - \ another account. See how to call Create cash, liability, holding, and tax account for a business (api/ledger-accounts/setup)\ - \ section of this document\n3. To be able to create payments with fee/VAT the\ - \ Product rate settings and VAT rate settings should be created using Transaction\ - \ Fee Service. See Fee Service Documentation for details about how to create Product/VAT rate\ - \ settings.\n\n\n## Transaction flows\n\nTo integrate with the Transaction Service\ - \ you should decide what types of transaction flows your integration will be using.\ - \ Transaction flow is set by the transaction `type` during transaction creation\n\ - \n1. Money In flows\n 1. Payment from credit card\n\n\n `type: CREDIT_CARD_PAYMENT`\n\ - \t\t\n\t\t\n 3. Payment from other sources without fee/VAT\n\n\n `type:\ - \ DEPOSIT, FOREX_DEPOSIT, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT,\ - \ PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK, BATCH_VA_PAYMENT`\n\t\t\n\t\t\n 4.\ - \ Payment from other sources with fee/VAT\n\n\n `type: VA_PAYMENT, IM_ESCROW_VA_PAYMENT,\ - \ IM_DEPOSIT, RO_PAYMENT, EWALLET_PAYMENT, CARDLESS_CREDIT_PAYMENT, IM_REMITTANCE_VA_PAYMENT,\ - \ PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER,\ - \ ACH_PAYMENT, CRYPTO_PAYMENT`\n\t\t\n\t\t\n 5. Billing deposit from cash\n\ - \n\n `type: BILLING_DEPOSIT`\n\t\t\n\t\t\n 6. Billing deposit from other\ - \ sources\n\n\n `type: BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT`\n\ - \t\t\n\t\t\n2. Money out flows\n 1. Instant payment\n\n\n `type: simple\ - \ money out types`\n\t\t\t\t\n `status: COMPLETED`\n\t\t\n\t\t\n 2.\ - \ Simple payment without fee/VAT\n\n\n `type: CHARGEBACK_DEDUCTION, FRAUD_DEDUCTION,\ - \ LOAN_REPAYMENT, FOREX_DEDUCTION, BNPL_PARTNER_SETTLEMENT_DEBIT, WITHDRAWAL`\n\ - \n\n 3. Simple payment with fee/VAT\n\n\n `type: ISSUING_FUNDING, BATCH_DISBURSEMENT,\ - \ CASH_DISBURSEMENT, DISBURSEMENT, REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT`\n\ - \t\t\n\t\t\n 4. Billing withdraw to cash\n\n\n `type: BILLING_WITHDRAWAL`\n\ - \t\t\n\t\t\n 4. Billing withdraw to other destinations\n\n\n `type:\ - \ BILL_PAYMENT`\n\t\t\n\t\t\n3. Reversal flow\n\n Some of transactions could\ - \ be reversed. See Reversible / non reversible transaction types section of this document. To\ - \ reverse transaction you should call Update transaction (/api/transactions/:id) endpoint with the transaction\ - \ status `REVERSED`.\n\t\t\n4. Void/Cancellation Flow\n\n Transaction in the\ - \ `PENDING_SETTLEMENT` status could be canceled. To do that you should call Update transaction (/api/transactions/:id)\ - \ endpoint with the transaction status `VOIDED`.\n\t\t\n\t\t\n5. Switcher flow\n\ - \n Switchers are transactions that do not affect the customer balance. These\ - \ are transactions that goes directly to the customers’ account and simply passes\ - \ through Xendit. Therefore, it will not impact the customer balance and we will\ - \ only charge Fee and VAT. To create switcher flow you should set `is_switcher_payment`\ - \ field to `true`.\n\n\n\n\t\t\n## Instant/non instant settlement\n\nTransactions\ - \ can be performed instantly (instant settlement) or with delay (non instant settlement).\ - \ Some of the transaction types are only instantly processed, some of them support\ - \ both instant and non instant settlement and some of them have only non instant\ - \ settlement. If settlement is instant than balance will be changed instantly.\ - \ In opposite case the transaction status has to be set into PENDING_SETTLEMENT\ - \ and settlement date should be provided. \n\n1. Instant settlement Money In transaction\ - \ types\n\n `DEPOSIT, BATCH_VA_PAYMENT, FOREX_DEPOSIT, IM_DEPOSIT, CARDLESS_CREDIT_PAYMENT,\ - \ ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_CREDIT, PROMO_FEE_CASHBACK,\ - \ PROMO_VAT_CASHBACK, REMITTANCE_VA_PAYMENT_CLAIM`\n\t\t\n2. Both instant and\ - \ non instant Money In transaction types\n\n `DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER,\ - \ ACH_PAYMENT, RO_PAYMENT, EWALLET_PAYMENT, QR_CODE_PAYMENT, VA_PAYMENT, INVOICE,\ - \ PAYLATER_PAYMENT`\n\n3. Non Instant settlement Money In transaction types\n\n\ - \ `CREDIT_CARD_PAYMENT`\n\t\t\n4. Instant settlement Money Out transaction\ - \ types\n\n `LOAN_REPAYMENT, FOREX_DEDUCTION, BILL_PAYMENT, ISSUING_FUNDING,\ - \ BNPL_PARTNER_SETTLEMENT_DEBIT, FRAUD_DEDUCTION`\n\n5. Both instant and non instant\ - \ settlement supported Money Out transaction types\n\n `CHARGEBACK_DEDUCTION`\n\ - \n6. Non Instant settlement Money Out transaction types\n\n All other money\ - \ out types are non instant settlement\n\n## Reversible / non reversible transaction\ - \ types\n\nSome transactions can be reversed. Here are the list of transaction\ - \ types that could be reversed: \n\n`CASH_DISBURSEMENT, DISBURSEMENT, BATCH_DISBURSEMENT,\ - \ REMITTANCE, REMITTANCE_PAYOUT, TAX_DISBURSEMENT, WITHDRAWAL, DEPOSIT, FOREX_DEPOSIT,\ - \ FOREX_DEDUCTION, VA_PAYMENT, BATCH_VA_PAYMENT, IM_REMITTANCE_VA_PAYMENT, IM_ESCROW_VA_PAYMENT,\ - \ IM_DEPOSIT, REMITTANCE_VA_PAYMENT, REMITTANCE_VA_PAYMENT_CLAIM, RO_PAYMENT,\ - \ CARDLESS_CREDIT_PAYMENT, PAYLATER_PAYMENT, INVOICE, QR_CODE_PAYMENT, CREDIT_CARD_PAYMENT,\ - \ EWALLET_PAYMENT, DIRECT_DEBIT_PAYMENT, DIRECT_BANK_TRANSFER, ACH_PAYMENT, CHARGEBACK_DEDUCTION,\ - \ FRAUD_DEDUCTION, LOAN_REPAYMENT, ISSUING_FUNDING, ISSUING_FUNDING_REFUND, BNPL_PARTNER_SETTLEMENT_DEBIT,\ - \ BNPL_PARTNER_SETTLEMENT_CREDIT, BILLING_DEPOSIT, BILLING_DIRECT_DEPOSIT, BILLING_VA_DIRECT_DEPOSIT,\ - \ BILLING_WITHDRAWAL, BILL_PAYMENT, PROMO_FEE_CASHBACK, PROMO_VAT_CASHBACK`\n\n\ - \ \n## How to create transaction\n\nAfter you created or already have the `BUSINESS_CASH`\ - \ ledger account ID (See Prerequisites\ - \ section) and you know what transaction flows are going to be used you can create\ - \ the new transaction using POST request to the Create a new transaction (/api/transactions) endpoint\n\n## How to update\ - \ transaction\n\nTo update transaction you should do PATCH request to the Update transaction (/api/transactions/::id)\ - \ endpoint\n\n\n" - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - title: Transaction Service V4 API - version: 3.4.3 - x-logo: - url: https://dashboard.xendit.co/assets/images/xendit-blue-logo.svg -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /balance: - get: - description: "Retrieves balance for your business, defaults to CASH type" - operationId: getBalance - parameters: - - description: The selected balance type - explode: true - in: query - name: account_type - required: false - schema: - default: CASH - enum: - - CASH - - HOLDING - - TAX - example: CASH - type: string - style: form - - description: Currency for filter for customers with multi currency accounts - explode: true - in: query - name: currency - required: false - schema: - example: IDR - type: string - style: form - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5dbf20d7c8eb0c0896f811b6 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Balance' - description: success - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - description: "invalid input, object invalid" - default: - content: - application/json: - schema: - $ref: '#/components/schemas/ServerError' - description: Errors - summary: "Retrieves balances for a business, default to CASH type" - tags: - - balance - /transactions: - get: - description: Get a list of all transactions based on filter and search parameters. - operationId: getAllTransactions - parameters: - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5dbf20d7c8eb0c0896f811b6 - type: string - style: simple - - description: Transaction types that will be included in the result. Default - is to include all transaction types - example: - - DISBURSEMENT - - PAYMENT - explode: true - in: query - name: types - required: false - schema: - items: - $ref: '#/components/schemas/TransactionTypes' - type: array - style: form - - description: Status of the transaction. Default is to include all status. - example: - - SUCCESS - - PENDING - explode: true - in: query - name: statuses - required: false - schema: - items: - $ref: '#/components/schemas/TransactionStatuses' - type: array - style: form - - description: Payment channels in which the transaction is carried out. Default - is to include all channels. - example: - - BANK - - INVOICE - explode: true - in: query - name: channel_categories - required: false - schema: - items: - $ref: '#/components/schemas/ChannelsCategories' - type: array - style: form - - description: To filter the result for transactions with matching reference - given (case sensitive) - example: ref23232 - explode: true - in: query - name: reference_id - required: false - schema: - type: string - style: form - - description: To filter the result for transactions with matching product_id - (a.k.a payment_id) given (case sensitive) - example: d290f1ee-6c54-4b01-90e6-d701748f0701 - explode: true - in: query - name: product_id - required: false - schema: - type: string - style: form - - description: "Account identifier of transaction. The format will be different\ - \ from each channel. For example, on `BANK` channel it will be account number\ - \ and on `CARD` it will be masked card number." - example: 123123123 - explode: true - in: query - name: account_identifier - required: false - schema: - type: string - style: form - - description: Specific transaction amount to search for - example: 100 - explode: true - in: query - name: amount - required: false - schema: - type: number - style: form - - explode: true - in: query - name: currency - required: false - schema: - $ref: '#/components/schemas/Currency' - style: form - - description: Filter time of transaction by created date. If not specified - will list all dates. - explode: true - in: query - name: created - required: false - schema: - $ref: '#/components/schemas/DateRangeFilter' - style: deepObject - - description: Filter time of transaction by updated date. If not specified - will list all dates. - explode: true - in: query - name: updated - required: false - schema: - $ref: '#/components/schemas/DateRangeFilter' - style: deepObject - - description: number of items in the result per page. Another name for "results_per_page" - example: 10 - explode: true - in: query - name: limit - required: false - schema: - default: 10 - maximum: 50 - type: number - style: form - - explode: true - in: query - name: after_id - required: false - schema: - $ref: '#/components/schemas/TransactionId' - style: form - - explode: true - in: query - name: before_id - required: false - schema: - $ref: '#/components/schemas/TransactionId' - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionsResponse' - description: List of transaction object - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - description: "invalid input, object invalid" - default: - content: - application/json: - schema: - $ref: '#/components/schemas/ServerError' - description: Errors - summary: Get a list of transactions - tags: - - transaction - /transactions/{id}: - get: - description: Get single specific transaction by transaction id. - operationId: getTransactionByID - parameters: - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5dbf20d7c8eb0c0896f811b6 - type: string - style: simple - - explode: false - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/TransactionId' - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionResponse' - description: OK - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - description: "invalid input, object invalid" - default: - content: - application/json: - schema: - $ref: '#/components/schemas/ServerError' - description: Errors - summary: Get a transaction based on its id - tags: - - transaction -components: - parameters: - TransactionTypes: - description: Transaction types that will be included in the result. Default - is to include all transaction types - example: - - DISBURSEMENT - - PAYMENT - explode: true - in: query - name: types - required: false - schema: - items: - $ref: '#/components/schemas/TransactionTypes' - type: array - style: form - TransactionStatuses: - description: Status of the transaction. Default is to include all status. - example: - - SUCCESS - - PENDING - explode: true - in: query - name: statuses - required: false - schema: - items: - $ref: '#/components/schemas/TransactionStatuses' - type: array - style: form - ChannelsCategories: - description: Payment channels in which the transaction is carried out. Default - is to include all channels. - example: - - BANK - - INVOICE - explode: true - in: query - name: channel_categories - required: false - schema: - items: - $ref: '#/components/schemas/ChannelsCategories' - type: array - style: form - ReferenceId: - description: To filter the result for transactions with matching reference given - (case sensitive) - example: ref23232 - explode: true - in: query - name: reference_id - required: false - schema: - type: string - style: form - ProductId: - description: To filter the result for transactions with matching product_id - (a.k.a payment_id) given (case sensitive) - example: d290f1ee-6c54-4b01-90e6-d701748f0701 - explode: true - in: query - name: product_id - required: false - schema: - type: string - style: form - AccountIdentifier: - description: "Account identifier of transaction. The format will be different\ - \ from each channel. For example, on `BANK` channel it will be account number\ - \ and on `CARD` it will be masked card number." - example: 123123123 - explode: true - in: query - name: account_identifier - required: false - schema: - type: string - style: form - Amount: - description: Specific transaction amount to search for - example: 100 - explode: true - in: query - name: amount - required: false - schema: - type: number - style: form - Limit: - description: number of items in the result per page. Another name for "results_per_page" - example: 10 - explode: true - in: query - name: limit - required: false - schema: - default: 10 - maximum: 50 - type: number - style: form - schemas: - Balance: - description: The balance remaining in your account - example: - balance: 123000.12 - properties: - balance: - example: 123000.12 - type: number - required: - - balance - type: object - LinkItem: - example: - method: GET - rel: next - href: /transactions?types=PAYMENT&statuses=SUCCESS&channel_categories=EWALLET&channel_categories=RETAIL_OUTLET&limit=2&after_id=txn_a765a3f0-34c0-41ee-8686-bca11835ebdc - properties: - href: - description: "URI of target, this will be to the next link." - example: /transactions?types=PAYMENT&statuses=SUCCESS&channel_categories=EWALLET&channel_categories=RETAIL_OUTLET&limit=2&after_id=txn_a765a3f0-34c0-41ee-8686-bca11835ebdc - type: string - rel: - description: The relationship between source and target. The value will - be `next`. - example: next - type: string - method: - description: "The HTTP method, the value will be `GET`." - example: GET - type: string - required: - - href - - method - - rel - type: object - TransactionsResponse: - description: Returns an array of Transaction Objects. Returns empty array when - there is no result. - example: - data: - - amount: 150.21 - settlement_status: PENDING - reference_id: My custom reference - created: 2016-08-29T09:12:33.001Z - fee: - third_party_withholding_tax: 10 - value_added_tax: 1 - xendit_withholding_tax: 10 - xendit_fee: 10 - status: PENDING - account_identifier: "123123123" - channel_code: BCA - type: null - channel_category: INVOICE - estimated_settlement_time: 2016-08-29T09:12:33.001Z - cashflow: MONEY_IN - product_id: d290f1ee-6c54-4b01-90e6-d701748f0851 - currency: IDR - id: txn_438e4b61-7c4c-4dbb-bbba-94a896bff333 - business_id: 5fc9f5b246f820517e38c84d - updated: 2016-08-29T09:12:33.001Z - status: SUCCESS - - amount: 150.21 - settlement_status: PENDING - reference_id: My custom reference - created: 2016-08-29T09:12:33.001Z - fee: - third_party_withholding_tax: 10 - value_added_tax: 1 - xendit_withholding_tax: 10 - xendit_fee: 10 - status: PENDING - account_identifier: "123123123" - channel_code: BCA - type: null - channel_category: INVOICE - estimated_settlement_time: 2016-08-29T09:12:33.001Z - cashflow: MONEY_IN - product_id: d290f1ee-6c54-4b01-90e6-d701748f0851 - currency: IDR - id: txn_438e4b61-7c4c-4dbb-bbba-94a896bff333 - business_id: 5fc9f5b246f820517e38c84d - updated: 2016-08-29T09:12:33.001Z - status: SUCCESS - links: - - method: GET - rel: next - href: /transactions?types=PAYMENT&statuses=SUCCESS&channel_categories=EWALLET&channel_categories=RETAIL_OUTLET&limit=2&after_id=txn_a765a3f0-34c0-41ee-8686-bca11835ebdc - - method: GET - rel: next - href: /transactions?types=PAYMENT&statuses=SUCCESS&channel_categories=EWALLET&channel_categories=RETAIL_OUTLET&limit=2&after_id=txn_a765a3f0-34c0-41ee-8686-bca11835ebdc - has_more: true - properties: - has_more: - description: Indicates whether there are more items to be queried with `after_id` - of the last item from the current result. Use the `links` to follow to - the next result. - type: boolean - links: - description: The links to the next page based on LinkItem if there is next - result. - items: - $ref: '#/components/schemas/LinkItem' - type: array - data: - items: - $ref: '#/components/schemas/TransactionResponse' - type: array - required: - - data - - has_more - type: object - DateRangeFilter: - properties: - gte: - description: Start time of transaction. If not specified will list all dates. - example: 2020-08-29T17:00:00Z - format: date-time - type: string - lte: - description: End time of transaction. If not specified will list all dates. - example: 2020-08-29T17:00:00Z - format: date-time - type: string - type: object - TransactionId: - description: The unique id of a transaction. It will have `txn_` as prefix - example: txn_438e4b61-7c4c-4dbb-bbba-94a896bff333 - pattern: "^txn_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - type: string - Currency: - enum: - - IDR - - PHP - - USD - - JPY - - VND - - SGD - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BRL - - BSD - - BTN - - BWP - - BYN - - BZD - - CAD - - CDF - - CHF - - CLP - - CNY - - COP - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GGP - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HRK - - HTG - - HUF - - ILS - - IMP - - INR - - IQD - - IRR - - ISK - - JEP - - JMD - - JOD - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRU - - MUR - - MVR - - MWK - - MXN - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SHP - - SLL - - SOS - - SPL - - SRD - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TVD - - TWD - - TZS - - UAH - - UGX - - UYU - - UZS - - VEF - - VUV - - WST - - XAF - - XCD - - XDR - - XOF - - XPF - - YER - - ZAR - - ZMW - - ZWD - example: IDR - type: string - ValidationError: - properties: - status_code: - example: 400 - type: number - error: - example: API_VALIDATION_ERROR - type: string - message: - example: \"from\" is required. \"status\" is required. \"currency\" is required - type: string - validation: - example: - source: query - keys: - - from - - status - - currency - nullable: true - type: object - required: - - error - - message - - status_code - type: object - ServerError: - properties: - status_code: - example: 500 - type: number - error: - example: Internal Server Error - type: string - message: - example: An internal server error occurred - type: string - required: - - error - - message - - status_code - type: object - TransactionTypes: - enum: - - BATCH_DISBURSEMENT - - DISBURSEMENT - - PAYMENT - - REMITTANCE - - REMITTANCE_PAYOUT - - REMITTANCE_COLLECTION - - TRANSFER - - PLATFORM_FEE - - REFUND - - CASHBACK - - TOPUP - - WITHDRAWAL - - OTHER - example: DISBURSEMENT - type: string - ChannelsCategories: - enum: - - BANK - - CARDLESS_CREDIT - - PAYLATER - - CARDS - - CASH - - DIRECT_DEBIT - - EWALLET - - INVOICE - - QR_CODE - - RETAIL_OUTLET - - VIRTUAL_ACCOUNT - - XENPLATFORM - - DIRECT_BANK_TRANSFER - - OTHER - example: INVOICE - type: string - TransactionResponse: - example: - amount: 150.21 - settlement_status: PENDING - reference_id: My custom reference - created: 2016-08-29T09:12:33.001Z - fee: - third_party_withholding_tax: 10 - value_added_tax: 1 - xendit_withholding_tax: 10 - xendit_fee: 10 - status: PENDING - account_identifier: "123123123" - channel_code: BCA - type: null - channel_category: INVOICE - estimated_settlement_time: 2016-08-29T09:12:33.001Z - cashflow: MONEY_IN - product_id: d290f1ee-6c54-4b01-90e6-d701748f0851 - currency: IDR - id: txn_438e4b61-7c4c-4dbb-bbba-94a896bff333 - business_id: 5fc9f5b246f820517e38c84d - updated: 2016-08-29T09:12:33.001Z - status: SUCCESS - properties: - id: - description: The unique id of a transaction. It will have `txn_` as prefix - example: txn_438e4b61-7c4c-4dbb-bbba-94a896bff333 - pattern: "^txn_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" - type: string - product_id: - description: The product_id of the transaction. Product id will have a different - prefix for each product. You can use this id to match the transaction - from this API to each product API. - example: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: string - type: - $ref: '#/components/schemas/TransactionResponse_type' - status: - $ref: '#/components/schemas/TransactionStatuses' - channel_category: - $ref: '#/components/schemas/ChannelsCategories' - channel_code: - description: "The channel of the transaction that is used. See [channel\ - \ codes](https://docs.xendit.co/xendisburse/channel-codes) for the list\ - \ of available per channel categories." - example: BCA - nullable: true - type: string - account_identifier: - description: Account identifier of transaction. The format will be different - from each channel. - example: "123123123" - nullable: true - type: string - reference_id: - description: customer supplied reference/external_id - example: My custom reference - type: string - currency: - $ref: '#/components/schemas/Currency' - amount: - description: The transaction amount. The number of decimal places will be - different for each currency according to ISO 4217. - example: 150.21 - type: number - cashflow: - description: "Representing whether the transaction is money in or money\ - \ out For transfer, the transfer out side it will shows up as money out\ - \ and on transfer in side in will shows up as money-in. Available values\ - \ are `MONEY_IN` for money in and `MONEY_OUT` for money out." - enum: - - MONEY_IN - - MONEY_OUT - type: string - settlement_status: - description: The settlement status of the transaction. `PENDING` - Transaction - amount has not been settled to merchant's balance. `SETTLED` - Transaction - has been settled to merchant's balance - enum: - - PENDING - - SETTLED - nullable: true - type: string - estimated_settlement_time: - description: "Estimated settlement time will only apply to money-in transactions.\ - \ For money-out transaction, the value will be `NULL`. Estimated settlement\ - \ time in which transaction amount will be settled to merchant's balance." - example: 2016-08-29T09:12:33.001Z - format: date-time - nullable: true - type: string - business_id: - description: The id of business where this transaction belong to - example: 5fc9f5b246f820517e38c84d - type: string - fee: - $ref: '#/components/schemas/FeeResponse' - created: - description: Transaction created timestamp (UTC+0) - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - updated: - description: Transaction updated timestamp (UTC+0) - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - required: - - account_identifier - - amount - - business_id - - cashflow - - channel_category - - channel_code - - created - - currency - - fee - - id - - product_id - - reference_id - - status - - type - - updated - type: object - FeeResponse: - example: - third_party_withholding_tax: 10 - value_added_tax: 1 - xendit_withholding_tax: 10 - xendit_fee: 10 - status: PENDING - properties: - xendit_fee: - description: Amount of the Xendit fee for this transaction. - example: 10 - type: number - value_added_tax: - description: Amount of the VAT for this transaction. - example: 1 - type: number - xendit_withholding_tax: - description: "Amount of the Xendit Withholding Tax for this transaction\ - \ if applicable. See [Tax Documentation](https://docs.xendit.co/fees-and-vat#vat)\ - \ for more information." - example: 10 - type: number - third_party_withholding_tax: - description: | - Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank - example: 10 - type: number - status: - enum: - - PENDING - - COMPLETED - - CANCELED - - REVERSED - type: string - required: - - value_added_tax - - xendit_fee - type: object - TransactionStatuses: - enum: - - SUCCESS - - PENDING - - FAILED - - REVERSED - - VOIDED - example: SUCCESS - type: string - TransactionResponse_type: - anyOf: - - $ref: '#/components/schemas/TransactionTypes' - - type: string - description: The type of the transactions. diff --git a/docs/balance_and_transaction/Balance.md b/docs/balance_and_transaction/Balance.md index 14bea107..b87a19b1 100644 --- a/docs/balance_and_transaction/Balance.md +++ b/docs/balance_and_transaction/Balance.md @@ -1,10 +1,10 @@ # Balance +The balance remaining in your account ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Balance** | **float32** | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Balance** | **float32** | ☑️ | | | ## Methods diff --git a/docs/balance_and_transaction/ChannelsCategories.md b/docs/balance_and_transaction/ChannelsCategories.md index 08611dc0..c93af8f7 100644 --- a/docs/balance_and_transaction/ChannelsCategories.md +++ b/docs/balance_and_transaction/ChannelsCategories.md @@ -1,37 +1,37 @@ # ChannelsCategories -## Enum - -* `BANK` (value: `"BANK"`) - -* `CARDLESS_CREDIT` (value: `"CARDLESS_CREDIT"`) - -* `PAYLATER` (value: `"PAYLATER"`) - -* `CARDS` (value: `"CARDS"`) - -* `CASH` (value: `"CASH"`) - -* `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `INVOICE` (value: `"INVOICE"`) - -* `QR_CODE` (value: `"QR_CODE"`) - -* `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) - -* `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) - -* `XENPLATFORM` (value: `"XENPLATFORM"`) - -* `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) - -* `OTHER` (value: `"OTHER"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `BANK` (value: `"BANK"`) + + * `CARDLESS_CREDIT` (value: `"CARDLESS_CREDIT"`) + + * `PAYLATER` (value: `"PAYLATER"`) + + * `CARDS` (value: `"CARDS"`) + + * `CASH` (value: `"CASH"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `INVOICE` (value: `"INVOICE"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XENPLATFORM` (value: `"XENPLATFORM"`) + + * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) + + * `OTHER` (value: `"OTHER"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/balance_and_transaction/Currency.md b/docs/balance_and_transaction/Currency.md index dc183e1d..a0d22b28 100644 --- a/docs/balance_and_transaction/Currency.md +++ b/docs/balance_and_transaction/Currency.md @@ -1,333 +1,333 @@ # Currency -## Enum - -* `IDR` (value: `"IDR"`) - -* `PHP` (value: `"PHP"`) - -* `USD` (value: `"USD"`) - -* `JPY` (value: `"JPY"`) - -* `VND` (value: `"VND"`) - -* `SGD` (value: `"SGD"`) - -* `AED` (value: `"AED"`) - -* `AFN` (value: `"AFN"`) - -* `ALL` (value: `"ALL"`) - -* `AMD` (value: `"AMD"`) - -* `ANG` (value: `"ANG"`) - -* `AOA` (value: `"AOA"`) - -* `ARS` (value: `"ARS"`) - -* `AUD` (value: `"AUD"`) - -* `AWG` (value: `"AWG"`) - -* `AZN` (value: `"AZN"`) - -* `BAM` (value: `"BAM"`) - -* `BBD` (value: `"BBD"`) - -* `BDT` (value: `"BDT"`) - -* `BGN` (value: `"BGN"`) - -* `BHD` (value: `"BHD"`) - -* `BIF` (value: `"BIF"`) - -* `BMD` (value: `"BMD"`) - -* `BND` (value: `"BND"`) - -* `BOB` (value: `"BOB"`) - -* `BRL` (value: `"BRL"`) - -* `BSD` (value: `"BSD"`) - -* `BTN` (value: `"BTN"`) - -* `BWP` (value: `"BWP"`) - -* `BYN` (value: `"BYN"`) - -* `BZD` (value: `"BZD"`) - -* `CAD` (value: `"CAD"`) - -* `CDF` (value: `"CDF"`) - -* `CHF` (value: `"CHF"`) - -* `CLP` (value: `"CLP"`) - -* `CNY` (value: `"CNY"`) - -* `COP` (value: `"COP"`) - -* `CRC` (value: `"CRC"`) - -* `CUC` (value: `"CUC"`) - -* `CUP` (value: `"CUP"`) - -* `CVE` (value: `"CVE"`) - -* `CZK` (value: `"CZK"`) - -* `DJF` (value: `"DJF"`) - -* `DKK` (value: `"DKK"`) - -* `DOP` (value: `"DOP"`) - -* `DZD` (value: `"DZD"`) - -* `EGP` (value: `"EGP"`) - -* `ERN` (value: `"ERN"`) - -* `ETB` (value: `"ETB"`) - -* `EUR` (value: `"EUR"`) - -* `FJD` (value: `"FJD"`) - -* `FKP` (value: `"FKP"`) - -* `GBP` (value: `"GBP"`) - -* `GEL` (value: `"GEL"`) - -* `GGP` (value: `"GGP"`) - -* `GHS` (value: `"GHS"`) - -* `GIP` (value: `"GIP"`) - -* `GMD` (value: `"GMD"`) - -* `GNF` (value: `"GNF"`) - -* `GTQ` (value: `"GTQ"`) - -* `GYD` (value: `"GYD"`) - -* `HKD` (value: `"HKD"`) - -* `HNL` (value: `"HNL"`) - -* `HRK` (value: `"HRK"`) - -* `HTG` (value: `"HTG"`) - -* `HUF` (value: `"HUF"`) - -* `ILS` (value: `"ILS"`) - -* `IMP` (value: `"IMP"`) - -* `INR` (value: `"INR"`) - -* `IQD` (value: `"IQD"`) - -* `IRR` (value: `"IRR"`) - -* `ISK` (value: `"ISK"`) - -* `JEP` (value: `"JEP"`) - -* `JMD` (value: `"JMD"`) - -* `JOD` (value: `"JOD"`) - -* `KES` (value: `"KES"`) - -* `KGS` (value: `"KGS"`) - -* `KHR` (value: `"KHR"`) - -* `KMF` (value: `"KMF"`) - -* `KPW` (value: `"KPW"`) - -* `KRW` (value: `"KRW"`) - -* `KWD` (value: `"KWD"`) - -* `KYD` (value: `"KYD"`) - -* `KZT` (value: `"KZT"`) - -* `LAK` (value: `"LAK"`) - -* `LBP` (value: `"LBP"`) - -* `LKR` (value: `"LKR"`) - -* `LRD` (value: `"LRD"`) - -* `LSL` (value: `"LSL"`) - -* `LYD` (value: `"LYD"`) - -* `MAD` (value: `"MAD"`) - -* `MDL` (value: `"MDL"`) - -* `MGA` (value: `"MGA"`) - -* `MKD` (value: `"MKD"`) - -* `MMK` (value: `"MMK"`) - -* `MNT` (value: `"MNT"`) - -* `MOP` (value: `"MOP"`) - -* `MRU` (value: `"MRU"`) - -* `MUR` (value: `"MUR"`) - -* `MVR` (value: `"MVR"`) - -* `MWK` (value: `"MWK"`) - -* `MXN` (value: `"MXN"`) - -* `MYR` (value: `"MYR"`) - -* `MZN` (value: `"MZN"`) - -* `NAD` (value: `"NAD"`) - -* `NGN` (value: `"NGN"`) - -* `NIO` (value: `"NIO"`) - -* `NOK` (value: `"NOK"`) - -* `NPR` (value: `"NPR"`) - -* `NZD` (value: `"NZD"`) - -* `OMR` (value: `"OMR"`) - -* `PAB` (value: `"PAB"`) - -* `PEN` (value: `"PEN"`) - -* `PGK` (value: `"PGK"`) - -* `PKR` (value: `"PKR"`) - -* `PLN` (value: `"PLN"`) - -* `PYG` (value: `"PYG"`) - -* `QAR` (value: `"QAR"`) - -* `RON` (value: `"RON"`) - -* `RSD` (value: `"RSD"`) - -* `RUB` (value: `"RUB"`) - -* `RWF` (value: `"RWF"`) - -* `SAR` (value: `"SAR"`) - -* `SBD` (value: `"SBD"`) - -* `SCR` (value: `"SCR"`) - -* `SDG` (value: `"SDG"`) - -* `SEK` (value: `"SEK"`) - -* `SHP` (value: `"SHP"`) - -* `SLL` (value: `"SLL"`) - -* `SOS` (value: `"SOS"`) - -* `SPL` (value: `"SPL"`) - -* `SRD` (value: `"SRD"`) - -* `STN` (value: `"STN"`) - -* `SVC` (value: `"SVC"`) - -* `SYP` (value: `"SYP"`) - -* `SZL` (value: `"SZL"`) - -* `THB` (value: `"THB"`) - -* `TJS` (value: `"TJS"`) - -* `TMT` (value: `"TMT"`) - -* `TND` (value: `"TND"`) - -* `TOP` (value: `"TOP"`) - -* `TRY` (value: `"TRY"`) - -* `TTD` (value: `"TTD"`) - -* `TVD` (value: `"TVD"`) - -* `TWD` (value: `"TWD"`) - -* `TZS` (value: `"TZS"`) - -* `UAH` (value: `"UAH"`) - -* `UGX` (value: `"UGX"`) - -* `UYU` (value: `"UYU"`) - -* `UZS` (value: `"UZS"`) - -* `VEF` (value: `"VEF"`) - -* `VUV` (value: `"VUV"`) - -* `WST` (value: `"WST"`) - -* `XAF` (value: `"XAF"`) - -* `XCD` (value: `"XCD"`) - -* `XDR` (value: `"XDR"`) - -* `XOF` (value: `"XOF"`) - -* `XPF` (value: `"XPF"`) - -* `YER` (value: `"YER"`) - -* `ZAR` (value: `"ZAR"`) - -* `ZMW` (value: `"ZMW"`) - -* `ZWD` (value: `"ZWD"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `IDR` (value: `"IDR"`) + + * `PHP` (value: `"PHP"`) + + * `USD` (value: `"USD"`) + + * `JPY` (value: `"JPY"`) + + * `VND` (value: `"VND"`) + + * `SGD` (value: `"SGD"`) + + * `AED` (value: `"AED"`) + + * `AFN` (value: `"AFN"`) + + * `ALL` (value: `"ALL"`) + + * `AMD` (value: `"AMD"`) + + * `ANG` (value: `"ANG"`) + + * `AOA` (value: `"AOA"`) + + * `ARS` (value: `"ARS"`) + + * `AUD` (value: `"AUD"`) + + * `AWG` (value: `"AWG"`) + + * `AZN` (value: `"AZN"`) + + * `BAM` (value: `"BAM"`) + + * `BBD` (value: `"BBD"`) + + * `BDT` (value: `"BDT"`) + + * `BGN` (value: `"BGN"`) + + * `BHD` (value: `"BHD"`) + + * `BIF` (value: `"BIF"`) + + * `BMD` (value: `"BMD"`) + + * `BND` (value: `"BND"`) + + * `BOB` (value: `"BOB"`) + + * `BRL` (value: `"BRL"`) + + * `BSD` (value: `"BSD"`) + + * `BTN` (value: `"BTN"`) + + * `BWP` (value: `"BWP"`) + + * `BYN` (value: `"BYN"`) + + * `BZD` (value: `"BZD"`) + + * `CAD` (value: `"CAD"`) + + * `CDF` (value: `"CDF"`) + + * `CHF` (value: `"CHF"`) + + * `CLP` (value: `"CLP"`) + + * `CNY` (value: `"CNY"`) + + * `COP` (value: `"COP"`) + + * `CRC` (value: `"CRC"`) + + * `CUC` (value: `"CUC"`) + + * `CUP` (value: `"CUP"`) + + * `CVE` (value: `"CVE"`) + + * `CZK` (value: `"CZK"`) + + * `DJF` (value: `"DJF"`) + + * `DKK` (value: `"DKK"`) + + * `DOP` (value: `"DOP"`) + + * `DZD` (value: `"DZD"`) + + * `EGP` (value: `"EGP"`) + + * `ERN` (value: `"ERN"`) + + * `ETB` (value: `"ETB"`) + + * `EUR` (value: `"EUR"`) + + * `FJD` (value: `"FJD"`) + + * `FKP` (value: `"FKP"`) + + * `GBP` (value: `"GBP"`) + + * `GEL` (value: `"GEL"`) + + * `GGP` (value: `"GGP"`) + + * `GHS` (value: `"GHS"`) + + * `GIP` (value: `"GIP"`) + + * `GMD` (value: `"GMD"`) + + * `GNF` (value: `"GNF"`) + + * `GTQ` (value: `"GTQ"`) + + * `GYD` (value: `"GYD"`) + + * `HKD` (value: `"HKD"`) + + * `HNL` (value: `"HNL"`) + + * `HRK` (value: `"HRK"`) + + * `HTG` (value: `"HTG"`) + + * `HUF` (value: `"HUF"`) + + * `ILS` (value: `"ILS"`) + + * `IMP` (value: `"IMP"`) + + * `INR` (value: `"INR"`) + + * `IQD` (value: `"IQD"`) + + * `IRR` (value: `"IRR"`) + + * `ISK` (value: `"ISK"`) + + * `JEP` (value: `"JEP"`) + + * `JMD` (value: `"JMD"`) + + * `JOD` (value: `"JOD"`) + + * `KES` (value: `"KES"`) + + * `KGS` (value: `"KGS"`) + + * `KHR` (value: `"KHR"`) + + * `KMF` (value: `"KMF"`) + + * `KPW` (value: `"KPW"`) + + * `KRW` (value: `"KRW"`) + + * `KWD` (value: `"KWD"`) + + * `KYD` (value: `"KYD"`) + + * `KZT` (value: `"KZT"`) + + * `LAK` (value: `"LAK"`) + + * `LBP` (value: `"LBP"`) + + * `LKR` (value: `"LKR"`) + + * `LRD` (value: `"LRD"`) + + * `LSL` (value: `"LSL"`) + + * `LYD` (value: `"LYD"`) + + * `MAD` (value: `"MAD"`) + + * `MDL` (value: `"MDL"`) + + * `MGA` (value: `"MGA"`) + + * `MKD` (value: `"MKD"`) + + * `MMK` (value: `"MMK"`) + + * `MNT` (value: `"MNT"`) + + * `MOP` (value: `"MOP"`) + + * `MRU` (value: `"MRU"`) + + * `MUR` (value: `"MUR"`) + + * `MVR` (value: `"MVR"`) + + * `MWK` (value: `"MWK"`) + + * `MXN` (value: `"MXN"`) + + * `MYR` (value: `"MYR"`) + + * `MZN` (value: `"MZN"`) + + * `NAD` (value: `"NAD"`) + + * `NGN` (value: `"NGN"`) + + * `NIO` (value: `"NIO"`) + + * `NOK` (value: `"NOK"`) + + * `NPR` (value: `"NPR"`) + + * `NZD` (value: `"NZD"`) + + * `OMR` (value: `"OMR"`) + + * `PAB` (value: `"PAB"`) + + * `PEN` (value: `"PEN"`) + + * `PGK` (value: `"PGK"`) + + * `PKR` (value: `"PKR"`) + + * `PLN` (value: `"PLN"`) + + * `PYG` (value: `"PYG"`) + + * `QAR` (value: `"QAR"`) + + * `RON` (value: `"RON"`) + + * `RSD` (value: `"RSD"`) + + * `RUB` (value: `"RUB"`) + + * `RWF` (value: `"RWF"`) + + * `SAR` (value: `"SAR"`) + + * `SBD` (value: `"SBD"`) + + * `SCR` (value: `"SCR"`) + + * `SDG` (value: `"SDG"`) + + * `SEK` (value: `"SEK"`) + + * `SHP` (value: `"SHP"`) + + * `SLL` (value: `"SLL"`) + + * `SOS` (value: `"SOS"`) + + * `SPL` (value: `"SPL"`) + + * `SRD` (value: `"SRD"`) + + * `STN` (value: `"STN"`) + + * `SVC` (value: `"SVC"`) + + * `SYP` (value: `"SYP"`) + + * `SZL` (value: `"SZL"`) + + * `THB` (value: `"THB"`) + + * `TJS` (value: `"TJS"`) + + * `TMT` (value: `"TMT"`) + + * `TND` (value: `"TND"`) + + * `TOP` (value: `"TOP"`) + + * `TRY` (value: `"TRY"`) + + * `TTD` (value: `"TTD"`) + + * `TVD` (value: `"TVD"`) + + * `TWD` (value: `"TWD"`) + + * `TZS` (value: `"TZS"`) + + * `UAH` (value: `"UAH"`) + + * `UGX` (value: `"UGX"`) + + * `UYU` (value: `"UYU"`) + + * `UZS` (value: `"UZS"`) + + * `VEF` (value: `"VEF"`) + + * `VUV` (value: `"VUV"`) + + * `WST` (value: `"WST"`) + + * `XAF` (value: `"XAF"`) + + * `XCD` (value: `"XCD"`) + + * `XDR` (value: `"XDR"`) + + * `XOF` (value: `"XOF"`) + + * `XPF` (value: `"XPF"`) + + * `YER` (value: `"YER"`) + + * `ZAR` (value: `"ZAR"`) + + * `ZMW` (value: `"ZMW"`) + + * `ZWD` (value: `"ZWD"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/balance_and_transaction/DateRangeFilter.md b/docs/balance_and_transaction/DateRangeFilter.md index 2840622e..4addff4f 100644 --- a/docs/balance_and_transaction/DateRangeFilter.md +++ b/docs/balance_and_transaction/DateRangeFilter.md @@ -1,11 +1,11 @@ # DateRangeFilter -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Gte** | Pointer to **time.Time** | Start time of transaction. If not specified will list all dates. | [optional] | -| **Lte** | Pointer to **time.Time** | End time of transaction. If not specified will list all dates. | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Gte** | Pointer to **time.Time** | | Start time of transaction. If not specified will list all dates. | | +| **Lte** | Pointer to **time.Time** | | End time of transaction. If not specified will list all dates. | | ## Methods diff --git a/docs/balance_and_transaction/FeeResponse.md b/docs/balance_and_transaction/FeeResponse.md index 73aa0015..c48dd943 100644 --- a/docs/balance_and_transaction/FeeResponse.md +++ b/docs/balance_and_transaction/FeeResponse.md @@ -1,14 +1,14 @@ # FeeResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **XenditFee** | **float32** | Amount of the Xendit fee for this transaction. | | -| **ValueAddedTax** | **float32** | Amount of the VAT for this transaction. | | -| **XenditWithholdingTax** | Pointer to **float32** | Amount of the Xendit Withholding Tax for this transaction if applicable. See [Tax Documentation](https://docs.xendit.co/fees-and-vat#vat) for more information. | [optional] | -| **ThirdPartyWithholdingTax** | Pointer to **float32** | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | [optional] | -| **Status** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **XenditFee** | **float32** | ☑️ | Amount of the Xendit fee for this transaction. | | +| **ValueAddedTax** | **float32** | ☑️ | Amount of the VAT for this transaction. | | +| **XenditWithholdingTax** | Pointer to **float32** | | Amount of the Xendit Withholding Tax for this transaction if applicable. See [Tax Documentation](https://docs.xendit.co/fees-and-vat#vat) for more information. | | +| **ThirdPartyWithholdingTax** | Pointer to **float32** | | Amount of the 3rd Party Withholding Tax for this transaction if applicable. 3rd party example: Bank | | +| **Status** | Pointer to **string** | | | | ## Methods diff --git a/docs/balance_and_transaction/LinkItem.md b/docs/balance_and_transaction/LinkItem.md index 3371b626..09d3ffed 100644 --- a/docs/balance_and_transaction/LinkItem.md +++ b/docs/balance_and_transaction/LinkItem.md @@ -1,12 +1,12 @@ # LinkItem -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Href** | **string** | URI of target, this will be to the next link. | | -| **Rel** | **string** | The relationship between source and target. The value will be `next`. | | -| **Method** | **string** | The HTTP method, the value will be `GET`. | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Href** | **string** | ☑️ | URI of target, this will be to the next link. | | +| **Rel** | **string** | ☑️ | The relationship between source and target. The value will be `next`. | | +| **Method** | **string** | ☑️ | The HTTP method, the value will be `GET`. | | ## Methods diff --git a/docs/balance_and_transaction/ServerError.md b/docs/balance_and_transaction/ServerError.md index dcd048c7..f507b395 100644 --- a/docs/balance_and_transaction/ServerError.md +++ b/docs/balance_and_transaction/ServerError.md @@ -1,12 +1,12 @@ # ServerError -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **StatusCode** | **float32** | | | -| **Error** | **string** | | | -| **Message** | **string** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **StatusCode** | **float32** | ☑️ | | | +| **Error** | **string** | ☑️ | | | +| **Message** | **string** | ☑️ | | | ## Methods diff --git a/docs/balance_and_transaction/TransactionResponse.md b/docs/balance_and_transaction/TransactionResponse.md index 31d739e4..03c9b826 100644 --- a/docs/balance_and_transaction/TransactionResponse.md +++ b/docs/balance_and_transaction/TransactionResponse.md @@ -1,26 +1,26 @@ # TransactionResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | The unique id of a transaction. It will have `txn_` as prefix | | -| **ProductId** | **string** | The product_id of the transaction. Product id will have a different prefix for each product. You can use this id to match the transaction from this API to each product API. | | -| **Type** | [**TransactionResponseType**](TransactionResponseType.md) | | | -| **Status** | [**TransactionStatuses**](TransactionStatuses.md) | | | -| **ChannelCategory** | [**ChannelsCategories**](ChannelsCategories.md) | | | -| **ChannelCode** | **NullableString** | The channel of the transaction that is used. See [channel codes](https://docs.xendit.co/xendisburse/channel-codes) for the list of available per channel categories. | | -| **AccountIdentifier** | **NullableString** | Account identifier of transaction. The format will be different from each channel. | | -| **ReferenceId** | **string** | customer supplied reference/external_id | | -| **Currency** | [**Currency**](Currency.md) | | | -| **Amount** | **float32** | The transaction amount. The number of decimal places will be different for each currency according to ISO 4217. | | -| **Cashflow** | **string** | Representing whether the transaction is money in or money out For transfer, the transfer out side it will shows up as money out and on transfer in side in will shows up as money-in. Available values are `MONEY_IN` for money in and `MONEY_OUT` for money out. | | -| **SettlementStatus** | Pointer to **NullableString** | The settlement status of the transaction. `PENDING` - Transaction amount has not been settled to merchant's balance. `SETTLED` - Transaction has been settled to merchant's balance | [optional] | -| **EstimatedSettlementTime** | Pointer to **NullableTime** | Estimated settlement time will only apply to money-in transactions. For money-out transaction, the value will be `NULL`. Estimated settlement time in which transaction amount will be settled to merchant's balance. | [optional] | -| **BusinessId** | **string** | The id of business where this transaction belong to | | -| **Fee** | [**FeeResponse**](FeeResponse.md) | | | -| **Created** | **time.Time** | Transaction created timestamp (UTC+0) | | -| **Updated** | **time.Time** | Transaction updated timestamp (UTC+0) | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | The unique id of a transaction. It will have `txn_` as prefix | | +| **ProductId** | **string** | ☑️ | The product_id of the transaction. Product id will have a different prefix for each product. You can use this id to match the transaction from this API to each product API. | | +| **Type** | [**TransactionResponseType**](TransactionResponseType.md) | ☑️ | | | +| **Status** | [**TransactionStatuses**](TransactionStatuses.md) | ☑️ | | | +| **ChannelCategory** | [**ChannelsCategories**](ChannelsCategories.md) | ☑️ | | | +| **ChannelCode** | **NullableString** | ☑️ | The channel of the transaction that is used. See [channel codes](https://docs.xendit.co/xendisburse/channel-codes) for the list of available per channel categories. | | +| **AccountIdentifier** | **NullableString** | ☑️ | Account identifier of transaction. The format will be different from each channel. | | +| **ReferenceId** | **string** | ☑️ | customer supplied reference/external_id | | +| **Currency** | [**Currency**](Currency.md) | ☑️ | | | +| **Amount** | **float32** | ☑️ | The transaction amount. The number of decimal places will be different for each currency according to ISO 4217. | | +| **Cashflow** | **string** | ☑️ | Representing whether the transaction is money in or money out For transfer, the transfer out side it will shows up as money out and on transfer in side in will shows up as money-in. Available values are `MONEY_IN` for money in and `MONEY_OUT` for money out. | | +| **SettlementStatus** | Pointer to **NullableString** | | The settlement status of the transaction. `PENDING` - Transaction amount has not been settled to merchant's balance. `SETTLED` - Transaction has been settled to merchant's balance | | +| **EstimatedSettlementTime** | Pointer to **NullableTime** | | Estimated settlement time will only apply to money-in transactions. For money-out transaction, the value will be `NULL`. Estimated settlement time in which transaction amount will be settled to merchant's balance. | | +| **BusinessId** | **string** | ☑️ | The id of business where this transaction belong to | | +| **Fee** | [**FeeResponse**](FeeResponse.md) | ☑️ | | | +| **Created** | **time.Time** | ☑️ | Transaction created timestamp (UTC+0) | | +| **Updated** | **time.Time** | ☑️ | Transaction updated timestamp (UTC+0) | | ## Methods diff --git a/docs/balance_and_transaction/TransactionResponseType.md b/docs/balance_and_transaction/TransactionResponseType.md index 2d43a9f9..d75275ab 100644 --- a/docs/balance_and_transaction/TransactionResponseType.md +++ b/docs/balance_and_transaction/TransactionResponseType.md @@ -1,9 +1,9 @@ # TransactionResponseType +The type of the transactions. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| ## Methods diff --git a/docs/balance_and_transaction/TransactionStatuses.md b/docs/balance_and_transaction/TransactionStatuses.md index 713c58a6..7f1a8372 100644 --- a/docs/balance_and_transaction/TransactionStatuses.md +++ b/docs/balance_and_transaction/TransactionStatuses.md @@ -1,19 +1,19 @@ # TransactionStatuses -## Enum - -* `SUCCESS` (value: `"SUCCESS"`) - -* `PENDING` (value: `"PENDING"`) - -* `FAILED` (value: `"FAILED"`) - -* `REVERSED` (value: `"REVERSED"`) - -* `VOIDED` (value: `"VOIDED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `SUCCESS` (value: `"SUCCESS"`) + + * `PENDING` (value: `"PENDING"`) + + * `FAILED` (value: `"FAILED"`) + + * `REVERSED` (value: `"REVERSED"`) + + * `VOIDED` (value: `"VOIDED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/balance_and_transaction/TransactionTypes.md b/docs/balance_and_transaction/TransactionTypes.md index d3de1694..a8cbfa33 100644 --- a/docs/balance_and_transaction/TransactionTypes.md +++ b/docs/balance_and_transaction/TransactionTypes.md @@ -1,35 +1,35 @@ # TransactionTypes -## Enum - -* `BATCH_DISBURSEMENT` (value: `"BATCH_DISBURSEMENT"`) - -* `DISBURSEMENT` (value: `"DISBURSEMENT"`) - -* `PAYMENT` (value: `"PAYMENT"`) - -* `REMITTANCE` (value: `"REMITTANCE"`) - -* `REMITTANCE_PAYOUT` (value: `"REMITTANCE_PAYOUT"`) - -* `REMITTANCE_COLLECTION` (value: `"REMITTANCE_COLLECTION"`) - -* `TRANSFER` (value: `"TRANSFER"`) - -* `PLATFORM_FEE` (value: `"PLATFORM_FEE"`) - -* `REFUND` (value: `"REFUND"`) - -* `CASHBACK` (value: `"CASHBACK"`) - -* `TOPUP` (value: `"TOPUP"`) - -* `WITHDRAWAL` (value: `"WITHDRAWAL"`) - -* `OTHER` (value: `"OTHER"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `BATCH_DISBURSEMENT` (value: `"BATCH_DISBURSEMENT"`) + + * `DISBURSEMENT` (value: `"DISBURSEMENT"`) + + * `PAYMENT` (value: `"PAYMENT"`) + + * `REMITTANCE` (value: `"REMITTANCE"`) + + * `REMITTANCE_PAYOUT` (value: `"REMITTANCE_PAYOUT"`) + + * `REMITTANCE_COLLECTION` (value: `"REMITTANCE_COLLECTION"`) + + * `TRANSFER` (value: `"TRANSFER"`) + + * `PLATFORM_FEE` (value: `"PLATFORM_FEE"`) + + * `REFUND` (value: `"REFUND"`) + + * `CASHBACK` (value: `"CASHBACK"`) + + * `TOPUP` (value: `"TOPUP"`) + + * `WITHDRAWAL` (value: `"WITHDRAWAL"`) + + * `OTHER` (value: `"OTHER"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/balance_and_transaction/TransactionsResponse.md b/docs/balance_and_transaction/TransactionsResponse.md index 15871049..44cb3b87 100644 --- a/docs/balance_and_transaction/TransactionsResponse.md +++ b/docs/balance_and_transaction/TransactionsResponse.md @@ -1,12 +1,12 @@ # TransactionsResponse +Returns an array of Transaction Objects. Returns empty array when there is no result. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **HasMore** | **bool** | Indicates whether there are more items to be queried with `after_id` of the last item from the current result. Use the `links` to follow to the next result. | | -| **Links** | Pointer to [**LinkItem[]**](LinkItem.md) | The links to the next page based on LinkItem if there is next result. | [optional] | -| **Data** | [**TransactionResponse[]**](TransactionResponse.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **HasMore** | **bool** | ☑️ | Indicates whether there are more items to be queried with `after_id` of the last item from the current result. Use the `links` to follow to the next result. | | +| **Links** | Pointer to [**LinkItem[]**](LinkItem.md) | | The links to the next page based on LinkItem if there is next result. | | +| **Data** | [**TransactionResponse[]**](TransactionResponse.md) | ☑️ | | | ## Methods diff --git a/docs/balance_and_transaction/ValidationError.md b/docs/balance_and_transaction/ValidationError.md index e2e4d06b..1947477d 100644 --- a/docs/balance_and_transaction/ValidationError.md +++ b/docs/balance_and_transaction/ValidationError.md @@ -1,13 +1,13 @@ # ValidationError -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **StatusCode** | **float32** | | | -| **Error** | **string** | | | -| **Message** | **string** | | | -| **Validation** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **StatusCode** | **float32** | ☑️ | | | +| **Error** | **string** | ☑️ | | | +| **Message** | **string** | ☑️ | | | +| **Validation** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/customer.yaml b/docs/customer.yaml deleted file mode 100644 index 6b450872..00000000 --- a/docs/customer.yaml +++ /dev/null @@ -1,1555 +0,0 @@ -openapi: 3.0.2 -info: - contact: - name: '#data-product-dev' - url: https://xendit.slack.com/archives/CA97LL668 - description: XENDIT SDK openapi spec - license: - name: No License - url: https://choosealicense.com/no-permission/ - title: XENDIT SDK openapi spec - version: 1.0.0 -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /customers: - get: - description: "Retrieves an array with a customer object that matches the provided\ - \ reference_id - the identifier provided by you For detail explanations, see\ - \ this link: https://developers.xendit.co/api-reference/#get-customer-by-reference-id" - operationId: getCustomerByReferenceID - parameters: - - description: Merchant's reference of end customer - explode: true - in: query - name: reference_id - required: true - schema: - maxLength: 255 - type: string - style: form - - description: The sub-account user-id that you want to make this transaction - for. - explode: false - in: header - name: for-user-id - required: false - schema: - example: user-1 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/getCustomerByReferenceID_200_response' - description: End Customers - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getCustomerByReferenceID_400_response' - description: Various errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error - summary: GET customers by reference id - tags: - - customer - post: - description: "Function to create a customer that you may use in your Invoice\ - \ or Payment Requests. For detail explanations, see this link: https://developers.xendit.co/api-reference/#create-customer" - operationId: createCustomer - parameters: - - description: A unique key to prevent processing duplicate requests. - explode: false - in: header - name: idempotency-key - required: false - schema: - example: idempotency-123 - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. - explode: false - in: header - name: for-user-id - required: false - schema: - example: user-1 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerRequest' - description: Request object for end customer object - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - description: Created End Customer - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/createCustomer_400_response' - description: Various errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error - summary: Create Customer - tags: - - customer - /customers/{id}: - get: - description: "Retrieves a single customer object For detail explanations, see\ - \ this link: https://developers.xendit.co/api-reference/#get-customer" - operationId: getCustomer - parameters: - - description: End customer resource id - explode: false - in: path - name: id - required: true - schema: - example: d290f1ee-6c54-4b01-90e6-d701748f0851 - format: uuid - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. - explode: false - in: header - name: for-user-id - required: false - schema: - example: user-1 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - description: End Customer Resource - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getCustomerByReferenceID_400_response' - description: Various errors - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseDataNotFound' - description: Customer not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error - summary: Get Customer By ID - tags: - - customer - patch: - description: "Function to update an existing customer. For a detailed explanation\ - \ For detail explanations, see this link: https://developers.xendit.co/api-reference/#update-customer" - operationId: updateCustomer - parameters: - - description: End customer resource id - explode: false - in: path - name: id - required: true - schema: - example: d290f1ee-6c54-4b01-90e6-d701748f0851 - format: uuid - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. - explode: false - in: header - name: for-user-id - required: false - schema: - example: user-1 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchCustomer' - description: Update Request for end customer object - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - description: Updated End Customer - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/updateCustomer_400_response' - description: Various errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Error - summary: Update End Customer Resource - tags: - - customer -components: - schemas: - Error: - properties: - error_code: - example: SERVER_ERROR - type: string - message: - example: "Something unexpected happened, we are investigating this issue\ - \ right now" - type: string - errors: - items: - type: object - type: array - required: - - error_code - - message - type: object - CountryCode: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - EmploymentDetail: - example: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - nullable: true - properties: - employer_name: - description: Name of employer - nullable: true - type: string - nature_of_business: - description: Industry or nature of business - nullable: true - type: string - role_description: - description: Occupation or title - nullable: true - type: string - type: object - IndividualDetail: - example: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - nullable: true - properties: - given_names: - maxLength: 255 - type: string - given_names_non_roman: - maxLength: 255 - nullable: true - type: string - middle_name: - maxLength: 255 - nullable: true - type: string - surname: - maxLength: 255 - nullable: true - type: string - surname_non_roman: - maxLength: 255 - nullable: true - type: string - mother_maiden_name: - maxLength: 255 - nullable: true - type: string - gender: - enum: - - MALE - - FEMALE - - OTHER - nullable: true - type: string - date_of_birth: - example: 2017-07-21 - maxLength: 30 - nullable: true - type: string - nationality: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - place_of_birth: - maxLength: 255 - nullable: true - type: string - employment: - $ref: '#/components/schemas/EmploymentDetail' - type: object - BusinessDetail: - example: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - nullable: true - properties: - business_name: - maxLength: 255 - type: string - business_type: - enum: - - CORPORATION - - SOLE_PROPRIETOR - - PARTNERSHIP - - COOPERATIVE - - TRUST - - NON_PROFIT - - GOVERNMENT - nullable: true - type: string - date_of_registration: - example: 2017-07-21 - maxLength: 10 - nullable: true - type: string - nature_of_business: - maxLength: 255 - nullable: true - type: string - business_domicile: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - type: object - AddressStatus: - enum: - - ACTIVE - - DELETED - nullable: true - type: string - Address: - example: - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - properties: - id: - example: d290f1ee-6c54-4b01-90e6-d701748f0851 - format: uuid - type: string - category: - maxLength: 255 - nullable: true - type: string - country: - allOf: - - $ref: '#/components/schemas/CountryCode' - - nullable: true - province_state: - nullable: true - type: string - city: - nullable: true - type: string - postal_code: - nullable: true - type: string - street_line1: - nullable: true - type: string - street_line2: - nullable: true - type: string - status: - $ref: '#/components/schemas/AddressStatus' - is_primary: - nullable: true - type: boolean - meta: - nullable: true - type: object - created: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - updated: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - required: - - category - - city - - country - - is_primary - - postal_code - - province_state - - street_line1 - - street_line2 - type: object - Currency: - description: "Primary currency of the account, if relevant. ISO 4217 Currency\ - \ Code" - example: IDR - type: string - AccountBank: - properties: - account_number: - description: Unique account identifier as per the bank records. - type: string - account_holder_name: - description: Name of account holder as per the bank records. Needs to match - the registered account name exactly. . - nullable: true - type: string - swift_code: - description: The SWIFT code for international payments - nullable: true - type: string - account_type: - description: "Free text account type, e.g., Savings, Transaction, Virtual\ - \ Account." - nullable: true - type: string - account_details: - description: "Potentially masked account detail, for display purposes only." - nullable: true - type: string - currency: - allOf: - - $ref: '#/components/schemas/Currency' - - nullable: true - type: object - AccountEwallet: - properties: - account_number: - description: Unique account identifier as per the bank records. - type: string - account_holder_name: - description: Name of account holder as per the bank records. Needs to match - the registered account name exactly. - nullable: true - type: string - currency: - allOf: - - $ref: '#/components/schemas/Currency' - - nullable: true - type: object - AccountCard: - properties: - token_id: - description: The token id returned in tokenisation - type: string - type: object - AccountOTC: - properties: - payment_code: - description: Complete fixed payment code (including prefix) - type: string - expires_at: - description: YYYY-MM-DD string with expiry date for the payment code - nullable: true - type: string - type: object - AccountQRCode: - properties: - qr_string: - description: String representation of the QR Code image - type: string - type: object - AccountPayLater: - properties: - account_id: - description: Alphanumeric string identifying this account. Usually an email - address or phone number. - type: string - account_holder_name: - description: Name of account holder as per the cardless credit account. - nullable: true - type: string - currency: - allOf: - - $ref: '#/components/schemas/Currency' - - nullable: true - type: object - IdentityAccountResponse: - example: - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - properties: - id: - example: d290f1ee-6c54-4b01-90e6-d701748f0851 - format: uuid - type: string - code: - nullable: true - type: string - company: - nullable: true - type: string - description: - nullable: true - type: string - country: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - holder_name: - nullable: true - type: string - type: - enum: - - BANK_ACCOUNT - - EWALLET - - CREDIT_CARD - - OTC - - QR_CODE - - CARDLESS_CREDIT - nullable: true - type: string - properties: - $ref: '#/components/schemas/IdentityAccountResponse_properties' - created: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - required: - - company - - country - - description - - properties - - type - type: object - KYCDocumentType: - enum: - - BIRTH_CERTIFICATE - - BANK_STATEMENT - - DRIVING_LICENSE - - IDENTITY_CARD - - PASSPORT - - VISA - - BUSINESS_REGISTRATION - - BUSINESS_LICENSE - type: string - KYCDocumentSubType: - enum: - - NATIONAL_ID - - CONSULAR_ID - - VOTER_ID - - POSTAL_ID - - RESIDENCE_PERMIT - - TAX_ID - - STUDENT_ID - - MILITARY_ID - - MEDICAL_ID - - OTHERS - nullable: true - type: string - KYCDocumentResponse: - example: - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - properties: - country: - allOf: - - $ref: '#/components/schemas/CountryCode' - - nullable: true - type: - allOf: - - $ref: '#/components/schemas/KYCDocumentType' - - nullable: true - sub_type: - allOf: - - $ref: '#/components/schemas/KYCDocumentSubType' - - nullable: true - document_name: - nullable: true - type: string - document_number: - nullable: true - type: string - expires_at: - nullable: true - type: string - holder_name: - nullable: true - type: string - document_images: - items: - type: string - nullable: true - type: array - required: - - country - - document_images - - document_name - - document_number - - expires_at - - holder_name - - sub_type - - type - type: object - EndCustomerStatus: - enum: - - ACTIVE - - INACTIVE - - PENDING - - BLOCKED - - DELETED - nullable: true - type: string - Customer: - example: - individual_detail: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - business_detail: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - addresses: - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - metadata: "{}" - reference_id: reference_id - kyc_documents: - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - created: 2016-08-29T09:12:33.001Z - description: description - type: INDIVIDUAL - phone_number: +6281295412345 - id: id - mobile_number: +6281295412345 - identity_accounts: - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - updated: 2016-08-29T09:12:33.001Z - email: info@xendit.co - status: null - properties: - type: - default: INDIVIDUAL - enum: - - INDIVIDUAL - - BUSINESS - type: string - reference_id: - description: "Merchant's reference of this end customer, eg Merchant's user's\ - \ id. Must be unique." - maxLength: 255 - type: string - individual_detail: - $ref: '#/components/schemas/IndividualDetail' - business_detail: - $ref: '#/components/schemas/BusinessDetail' - description: - maxLength: 1000 - nullable: true - type: string - email: - example: info@xendit.co - format: email - nullable: true - type: string - mobile_number: - example: +6281295412345 - format: E164 - nullable: true - type: string - phone_number: - example: +6281295412345 - format: E164 - nullable: true - type: string - addresses: - items: - $ref: '#/components/schemas/Address' - nullable: true - type: array - identity_accounts: - items: - $ref: '#/components/schemas/IdentityAccountResponse' - nullable: true - type: array - kyc_documents: - items: - $ref: '#/components/schemas/KYCDocumentResponse' - nullable: true - type: array - metadata: - nullable: true - type: object - status: - $ref: '#/components/schemas/EndCustomerStatus' - id: - type: string - created: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - updated: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - required: - - addresses - - business_detail - - created - - description - - email - - id - - identity_accounts - - individual_detail - - kyc_documents - - metadata - - mobile_number - - phone_number - - reference_id - - type - - updated - type: object - AddressRequest: - example: - line_1: line_1 - country_code: ID - line_2: line_2 - is_primary: false - city: city - province_state: province_state - suburb: suburb - category: category - postal_code: postal_code - status: null - properties: - category: - description: "Home, work or provincial" - maxLength: 255 - type: string - country_code: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - province_state: - type: string - city: - type: string - suburb: - type: string - postal_code: - type: string - line_1: - type: string - line_2: - type: string - status: - $ref: '#/components/schemas/AddressStatus' - is_primary: - default: false - type: boolean - type: object - IdentityAccountType: - enum: - - BANK_ACCOUNT - - EWALLET - - CREDIT_CARD - - PAY_LATER - - OTC - - QR_CODE - type: string - IdentityAccountRequest: - example: - country: ID - description: description - company: company - type: null - properties: null - properties: - type: - $ref: '#/components/schemas/IdentityAccountType' - company: - description: "The issuing institution associated with the account (e.g.,\ - \ OCBC, GOPAY, 7-11). If adding financial accounts that Xendit supports,\ - \ we recommend you use the channel_name found at https://xendit.github.io/apireference/#payment-channels\ - \ for this field" - maxLength: 100 - type: string - description: - description: Free text description of this account - maxLength: 255 - type: string - country: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - properties: - $ref: '#/components/schemas/IdentityAccountRequest_properties' - type: object - KYCDocumentRequest: - example: - country: ID - document_name: KTP - document_number: AA123467890 - expires_at: 2017-07-21 - sub_type: null - type: null - document_images: - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - holder_name: John Doe - properties: - country: - description: ISO3166-2 country code - example: ID - maxLength: 2 - nullable: true - type: string - type: - $ref: '#/components/schemas/KYCDocumentType' - sub_type: - $ref: '#/components/schemas/KYCDocumentSubType' - document_name: - example: KTP - type: string - document_number: - example: AA123467890 - type: string - expires_at: - example: 2017-07-21 - type: string - holder_name: - example: John Doe - type: string - document_images: - items: - description: pointer to file stored in xendit s3 - example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - type: string - type: array - type: object - CustomerRequest: - example: - individual_detail: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - business_detail: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - addresses: - - line_1: line_1 - country_code: ID - line_2: line_2 - is_primary: false - city: city - province_state: province_state - suburb: suburb - category: category - postal_code: postal_code - status: null - - line_1: line_1 - country_code: ID - line_2: line_2 - is_primary: false - city: city - province_state: province_state - suburb: suburb - category: category - postal_code: postal_code - status: null - metadata: "{}" - reference_id: reference_id - kyc_documents: - - country: ID - document_name: KTP - document_number: AA123467890 - expires_at: 2017-07-21 - sub_type: null - type: null - document_images: - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - holder_name: John Doe - - country: ID - document_name: KTP - document_number: AA123467890 - expires_at: 2017-07-21 - sub_type: null - type: null - document_images: - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - holder_name: John Doe - description: description - type: INDIVIDUAL - phone_number: +6281295412345 - mobile_number: +6281295412345 - client_name: AirAsia Indonesia - identity_accounts: - - country: ID - description: description - company: company - type: null - properties: null - - country: ID - description: description - company: company - type: null - properties: null - email: info@xendit.co - properties: - client_name: - description: Entity's name for this client - example: AirAsia Indonesia - type: string - reference_id: - description: "Merchant's reference of this end customer, eg Merchant's user's\ - \ id. Must be unique." - maxLength: 255 - type: string - type: - default: INDIVIDUAL - enum: - - INDIVIDUAL - - BUSINESS - type: string - individual_detail: - $ref: '#/components/schemas/IndividualDetail' - business_detail: - $ref: '#/components/schemas/BusinessDetail' - description: - maxLength: 1000 - nullable: true - type: string - email: - example: info@xendit.co - format: email - type: string - mobile_number: - example: +6281295412345 - format: E164 - type: string - phone_number: - example: +6281295412345 - format: E164 - type: string - addresses: - items: - $ref: '#/components/schemas/AddressRequest' - type: array - identity_accounts: - items: - $ref: '#/components/schemas/IdentityAccountRequest' - type: array - kyc_documents: - items: - $ref: '#/components/schemas/KYCDocumentRequest' - type: array - metadata: - type: object - required: - - client - - entity - - reference_id - type: object - ResponseDataNotFound: - properties: - error_code: - enum: - - DATA_NOT_FOUND - - ENTITY_NOT_FOUND_ERROR - - CLIENT_NOT_FOUND_ERROR - example: DATA_NOT_FOUND - type: string - message: - example: Provided customer_id does not exist - type: object - PatchCustomer: - example: - individual_detail: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - business_detail: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - metadata: "{}" - addresses: - - line_1: line_1 - country_code: ID - line_2: line_2 - is_primary: false - city: city - province_state: province_state - suburb: suburb - category: category - postal_code: postal_code - status: null - - line_1: line_1 - country_code: ID - line_2: line_2 - is_primary: false - city: city - province_state: province_state - suburb: suburb - category: category - postal_code: postal_code - status: null - reference_id: reference_id - kyc_documents: - - country: ID - document_name: KTP - document_number: AA123467890 - expires_at: 2017-07-21 - sub_type: null - type: null - document_images: - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - holder_name: John Doe - - country: ID - document_name: KTP - document_number: AA123467890 - expires_at: 2017-07-21 - sub_type: null - type: null - document_images: - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - - /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwc= - holder_name: John Doe - description: description - phone_number: +6281295412345 - mobile_number: +6281295412345 - client_name: AirAsia Indonesia - identity_accounts: - - country: ID - description: description - company: company - type: null - properties: null - - country: ID - description: description - company: company - type: null - properties: null - email: info@xendit.co - status: null - properties: - client_name: - description: Entity's name for this client - example: AirAsia Indonesia - nullable: true - type: string - reference_id: - description: "Merchant's reference of this end customer, eg Merchant's user's\ - \ id. Must be unique." - maxLength: 255 - nullable: true - type: string - individual_detail: - $ref: '#/components/schemas/IndividualDetail' - business_detail: - $ref: '#/components/schemas/BusinessDetail' - description: - maxLength: 1000 - nullable: true - type: string - email: - example: info@xendit.co - format: email - nullable: true - type: string - mobile_number: - example: +6281295412345 - format: E164 - nullable: true - type: string - phone_number: - example: +6281295412345 - format: E164 - nullable: true - type: string - metadata: - nullable: true - type: object - addresses: - items: - $ref: '#/components/schemas/AddressRequest' - nullable: true - type: array - identity_accounts: - items: - $ref: '#/components/schemas/IdentityAccountRequest' - nullable: true - type: array - kyc_documents: - items: - $ref: '#/components/schemas/KYCDocumentRequest' - nullable: true - type: array - status: - $ref: '#/components/schemas/EndCustomerStatus' - required: - - client - - entity - type: object - getCustomerByReferenceID_200_response: - example: - data: - - individual_detail: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - business_detail: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - addresses: - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - metadata: "{}" - reference_id: reference_id - kyc_documents: - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - created: 2016-08-29T09:12:33.001Z - description: description - type: INDIVIDUAL - phone_number: +6281295412345 - id: id - mobile_number: +6281295412345 - identity_accounts: - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - updated: 2016-08-29T09:12:33.001Z - email: info@xendit.co - status: null - - individual_detail: - place_of_birth: place_of_birth - gender: MALE - nationality: ID - surname: surname - date_of_birth: 2017-07-21 - surname_non_roman: surname_non_roman - employment: - nature_of_business: nature_of_business - employer_name: employer_name - role_description: role_description - given_names: given_names - given_names_non_roman: given_names_non_roman - middle_name: middle_name - mother_maiden_name: mother_maiden_name - business_detail: - business_name: business_name - nature_of_business: nature_of_business - business_type: CORPORATION - date_of_registration: 2017-07-21 - business_domicile: ID - addresses: - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - - country: "" - is_primary: true - city: city - created: 2016-08-29T09:12:33.001Z - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - meta: "{}" - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - category: category - postal_code: postal_code - updated: 2016-08-29T09:12:33.001Z - status: null - metadata: "{}" - reference_id: reference_id - kyc_documents: - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - - country: "" - document_name: document_name - document_number: document_number - expires_at: expires_at - sub_type: "" - type: "" - document_images: - - document_images - - document_images - holder_name: holder_name - created: 2016-08-29T09:12:33.001Z - description: description - type: INDIVIDUAL - phone_number: +6281295412345 - id: id - mobile_number: +6281295412345 - identity_accounts: - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - - country: ID - code: code - created: 2016-08-29T09:12:33.001Z - description: description - company: company - id: d290f1ee-6c54-4b01-90e6-d701748f0851 - type: BANK_ACCOUNT - properties: null - holder_name: holder_name - updated: 2016-08-29T09:12:33.001Z - email: info@xendit.co - status: null - has_more: true - properties: - has_more: - type: boolean - data: - items: - $ref: '#/components/schemas/Customer' - type: array - type: object - getCustomerByReferenceID_400_response_allOf: - properties: - error_code: - enum: - - ENTITY_NOT_FOUND_ERROR - - CLIENT_NOT_FOUND_ERROR - - END_CUSTOMER_NOT_FOUND_ERROR - - API_VALIDATION_ERROR - example: ENTITY_NOT_FOUND_ERROR - type: string - message: - example: Entity does not exist - type: object - getCustomerByReferenceID_400_response: - allOf: - - $ref: '#/components/schemas/Error' - - $ref: '#/components/schemas/getCustomerByReferenceID_400_response_allOf' - createCustomer_400_response_allOf: - properties: - error_code: - enum: - - DUPLICATE_END_CUSTOMER_ERROR - - API_VALIDATION_ERROR - example: DUPLICATE_END_CUSTOMER_ERROR - type: string - message: - example: Client reference already exist - type: object - createCustomer_400_response: - allOf: - - $ref: '#/components/schemas/Error' - - $ref: '#/components/schemas/createCustomer_400_response_allOf' - updateCustomer_400_response_allOf: - properties: - error_code: - enum: - - ENTITY_NOT_FOUND_ERROR - - CLIENT_NOT_FOUND_ERROR - - END_CUSTOMER_NOT_FOUND_ERROR - - DUPLICATE_END_CUSTOMER_ERROR - - API_VALIDATION_ERROR - example: ENTITY_NOT_FOUND_ERROR - type: string - message: - example: Entity does not exist - type: object - updateCustomer_400_response: - allOf: - - $ref: '#/components/schemas/Error' - - $ref: '#/components/schemas/updateCustomer_400_response_allOf' - IdentityAccountResponse_properties: - anyOf: - - $ref: '#/components/schemas/AccountBank' - - $ref: '#/components/schemas/AccountEwallet' - - $ref: '#/components/schemas/AccountCard' - - $ref: '#/components/schemas/AccountOTC' - - $ref: '#/components/schemas/AccountQRCode' - - $ref: '#/components/schemas/AccountPayLater' - IdentityAccountRequest_properties: - anyOf: - - $ref: '#/components/schemas/AccountBank' - - $ref: '#/components/schemas/AccountEwallet' - - $ref: '#/components/schemas/AccountCard' - - $ref: '#/components/schemas/AccountPayLater' - - $ref: '#/components/schemas/AccountOTC' - - $ref: '#/components/schemas/AccountQRCode' -x-owner: xendit -x-repositories: -- name: iluma-identity-service-v2 - branch: master -x-repositories-folder: docs/repositories diff --git a/docs/customer/AccountBank.md b/docs/customer/AccountBank.md index 61b5fdc3..7f4efd1b 100644 --- a/docs/customer/AccountBank.md +++ b/docs/customer/AccountBank.md @@ -1,15 +1,15 @@ # AccountBank -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountNumber** | Pointer to **string** | Unique account identifier as per the bank records. | [optional] | -| **AccountHolderName** | Pointer to **NullableString** | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | [optional] | -| **SwiftCode** | Pointer to **NullableString** | The SWIFT code for international payments | [optional] | -| **AccountType** | Pointer to **NullableString** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **AccountDetails** | Pointer to **NullableString** | Potentially masked account detail, for display purposes only. | [optional] | -| **Currency** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountNumber** | Pointer to **string** | | Unique account identifier as per the bank records. | | +| **AccountHolderName** | Pointer to **NullableString** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. . | | +| **SwiftCode** | Pointer to **NullableString** | | The SWIFT code for international payments | | +| **AccountType** | Pointer to **NullableString** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **AccountDetails** | Pointer to **NullableString** | | Potentially masked account detail, for display purposes only. | | +| **Currency** | Pointer to **string** | | | | ## Methods diff --git a/docs/customer/AccountCard.md b/docs/customer/AccountCard.md index 817a834a..fb75d7f1 100644 --- a/docs/customer/AccountCard.md +++ b/docs/customer/AccountCard.md @@ -1,10 +1,10 @@ # AccountCard -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **TokenId** | Pointer to **string** | The token id returned in tokenisation | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **TokenId** | Pointer to **string** | | The token id returned in tokenisation | | ## Methods diff --git a/docs/customer/AccountEwallet.md b/docs/customer/AccountEwallet.md index ff54804c..717f2823 100644 --- a/docs/customer/AccountEwallet.md +++ b/docs/customer/AccountEwallet.md @@ -1,12 +1,12 @@ # AccountEwallet -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountNumber** | Pointer to **string** | Unique account identifier as per the bank records. | [optional] | -| **AccountHolderName** | Pointer to **NullableString** | Name of account holder as per the bank records. Needs to match the registered account name exactly. | [optional] | -| **Currency** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountNumber** | Pointer to **string** | | Unique account identifier as per the bank records. | | +| **AccountHolderName** | Pointer to **NullableString** | | Name of account holder as per the bank records. Needs to match the registered account name exactly. | | +| **Currency** | Pointer to **string** | | | | ## Methods diff --git a/docs/customer/AccountOTC.md b/docs/customer/AccountOTC.md index ec63ba92..b6dd3924 100644 --- a/docs/customer/AccountOTC.md +++ b/docs/customer/AccountOTC.md @@ -1,11 +1,11 @@ # AccountOTC -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **PaymentCode** | Pointer to **string** | Complete fixed payment code (including prefix) | [optional] | -| **ExpiresAt** | Pointer to **NullableString** | YYYY-MM-DD string with expiry date for the payment code | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **PaymentCode** | Pointer to **string** | | Complete fixed payment code (including prefix) | | +| **ExpiresAt** | Pointer to **NullableString** | | YYYY-MM-DD string with expiry date for the payment code | | ## Methods diff --git a/docs/customer/AccountPayLater.md b/docs/customer/AccountPayLater.md index d4f3ba1d..4e198e71 100644 --- a/docs/customer/AccountPayLater.md +++ b/docs/customer/AccountPayLater.md @@ -1,12 +1,12 @@ # AccountPayLater -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountId** | Pointer to **string** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | -| **AccountHolderName** | Pointer to **NullableString** | Name of account holder as per the cardless credit account. | [optional] | -| **Currency** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountId** | Pointer to **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | +| **AccountHolderName** | Pointer to **NullableString** | | Name of account holder as per the cardless credit account. | | +| **Currency** | Pointer to **string** | | | | ## Methods diff --git a/docs/customer/AccountQRCode.md b/docs/customer/AccountQRCode.md index 56526e53..27567445 100644 --- a/docs/customer/AccountQRCode.md +++ b/docs/customer/AccountQRCode.md @@ -1,10 +1,10 @@ # AccountQRCode -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **QrString** | Pointer to **string** | String representation of the QR Code image | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **QrString** | Pointer to **string** | | String representation of the QR Code image | | ## Methods diff --git a/docs/customer/Address.md b/docs/customer/Address.md index 21aac0dd..956904a2 100644 --- a/docs/customer/Address.md +++ b/docs/customer/Address.md @@ -1,22 +1,22 @@ # Address -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | Pointer to **string** | | [optional] | -| **Category** | **NullableString** | | | -| **Country** | **string** | | | -| **ProvinceState** | **NullableString** | | | -| **City** | **NullableString** | | | -| **PostalCode** | **NullableString** | | | -| **StreetLine1** | **NullableString** | | | -| **StreetLine2** | **NullableString** | | | -| **Status** | Pointer to [**NullableAddressStatus**](AddressStatus.md) | | [optional] | -| **IsPrimary** | **NullableBool** | | | -| **Meta** | Pointer to **map[string]interface{}** | | [optional] | -| **Created** | Pointer to **time.Time** | | [optional] | -| **Updated** | Pointer to **time.Time** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | Pointer to **string** | | | | +| **Category** | **NullableString** | ☑️ | | | +| **Country** | **string** | ☑️ | | | +| **ProvinceState** | **NullableString** | ☑️ | | | +| **City** | **NullableString** | ☑️ | | | +| **PostalCode** | **NullableString** | ☑️ | | | +| **StreetLine1** | **NullableString** | ☑️ | | | +| **StreetLine2** | **NullableString** | ☑️ | | | +| **Status** | Pointer to [**NullableAddressStatus**](AddressStatus.md) | | | | +| **IsPrimary** | **NullableBool** | ☑️ | | | +| **Meta** | Pointer to **map[string]interface{}** | | | | +| **Created** | Pointer to **time.Time** | | | | +| **Updated** | Pointer to **time.Time** | | | | ## Methods diff --git a/docs/customer/AddressRequest.md b/docs/customer/AddressRequest.md index 92b89f4c..4c0017ed 100644 --- a/docs/customer/AddressRequest.md +++ b/docs/customer/AddressRequest.md @@ -1,19 +1,19 @@ # AddressRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Category** | Pointer to **string** | Home, work or provincial | [optional] | -| **CountryCode** | Pointer to **NullableString** | ISO3166-2 country code | [optional] | -| **ProvinceState** | Pointer to **string** | | [optional] | -| **City** | Pointer to **string** | | [optional] | -| **Suburb** | Pointer to **string** | | [optional] | -| **PostalCode** | Pointer to **string** | | [optional] | -| **Line1** | Pointer to **string** | | [optional] | -| **Line2** | Pointer to **string** | | [optional] | -| **Status** | Pointer to [**NullableAddressStatus**](AddressStatus.md) | | [optional] | -| **IsPrimary** | Pointer to **bool** | | [optional] [default to false] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Category** | Pointer to **string** | | Home, work or provincial | | +| **CountryCode** | Pointer to **NullableString** | | ISO3166-2 country code | | +| **ProvinceState** | Pointer to **string** | | | | +| **City** | Pointer to **string** | | | | +| **Suburb** | Pointer to **string** | | | | +| **PostalCode** | Pointer to **string** | | | | +| **Line1** | Pointer to **string** | | | | +| **Line2** | Pointer to **string** | | | | +| **Status** | Pointer to [**NullableAddressStatus**](AddressStatus.md) | | | | +| **IsPrimary** | Pointer to **bool** | | | [false] | ## Methods diff --git a/docs/customer/AddressStatus.md b/docs/customer/AddressStatus.md index f28c3499..608ba09d 100644 --- a/docs/customer/AddressStatus.md +++ b/docs/customer/AddressStatus.md @@ -1,13 +1,13 @@ # AddressStatus -## Enum - -* `ACTIVE` (value: `"ACTIVE"`) - -* `DELETED` (value: `"DELETED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `ACTIVE` (value: `"ACTIVE"`) + + * `DELETED` (value: `"DELETED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/customer/BusinessDetail.md b/docs/customer/BusinessDetail.md index df1e5ee2..d0daf090 100644 --- a/docs/customer/BusinessDetail.md +++ b/docs/customer/BusinessDetail.md @@ -1,14 +1,14 @@ # BusinessDetail -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **BusinessName** | Pointer to **string** | | [optional] | -| **BusinessType** | Pointer to **NullableString** | | [optional] | -| **DateOfRegistration** | Pointer to **NullableString** | | [optional] | -| **NatureOfBusiness** | Pointer to **NullableString** | | [optional] | -| **BusinessDomicile** | Pointer to **NullableString** | ISO3166-2 country code | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **BusinessName** | Pointer to **string** | | | | +| **BusinessType** | Pointer to **NullableString** | | | | +| **DateOfRegistration** | Pointer to **NullableString** | | | | +| **NatureOfBusiness** | Pointer to **NullableString** | | | | +| **BusinessDomicile** | Pointer to **NullableString** | | ISO3166-2 country code | | ## Methods diff --git a/docs/customer/CreateCustomer400Response.md b/docs/customer/CreateCustomer400Response.md index 2791f24d..54f645d8 100644 --- a/docs/customer/CreateCustomer400Response.md +++ b/docs/customer/CreateCustomer400Response.md @@ -1,12 +1,12 @@ # CreateCustomer400Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | | | -| **Message** | **interface{}** | | | -| **Errors** | Pointer to **map[string]interface{}[]** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | | | +| **Message** | **interface{}** | ☑️ | | | +| **Errors** | Pointer to **map[string]interface{}[]** | | | | ## Methods diff --git a/docs/customer/CreateCustomer400ResponseAllOf.md b/docs/customer/CreateCustomer400ResponseAllOf.md index b778d162..f1c3bb83 100644 --- a/docs/customer/CreateCustomer400ResponseAllOf.md +++ b/docs/customer/CreateCustomer400ResponseAllOf.md @@ -1,11 +1,11 @@ # CreateCustomer400ResponseAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **interface{}** | | | | ## Methods diff --git a/docs/customer/Customer.md b/docs/customer/Customer.md index 5ecea782..b8586539 100644 --- a/docs/customer/Customer.md +++ b/docs/customer/Customer.md @@ -1,25 +1,25 @@ # Customer -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | **string** | | [default to "INDIVIDUAL"] | -| **ReferenceId** | **string** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | -| **IndividualDetail** | [**NullableIndividualDetail**](IndividualDetail.md) | | | -| **BusinessDetail** | [**NullableBusinessDetail**](BusinessDetail.md) | | | -| **Description** | **NullableString** | | | -| **Email** | **NullableString** | | | -| **MobileNumber** | **NullableString** | | | -| **PhoneNumber** | **NullableString** | | | -| **Addresses** | [**Address[]**](Address.md) | | | -| **IdentityAccounts** | [**IdentityAccountResponse[]**](IdentityAccountResponse.md) | | | -| **KycDocuments** | [**KYCDocumentResponse[]**](KYCDocumentResponse.md) | | | -| **Metadata** | **map[string]interface{}** | | | -| **Status** | Pointer to [**NullableEndCustomerStatus**](EndCustomerStatus.md) | | [optional] | -| **Id** | **string** | | | -| **Created** | **time.Time** | | | -| **Updated** | **time.Time** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | **string** | ☑️ | | ["INDIVIDUAL"] | +| **ReferenceId** | **string** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | +| **IndividualDetail** | [**NullableIndividualDetail**](IndividualDetail.md) | ☑️ | | | +| **BusinessDetail** | [**NullableBusinessDetail**](BusinessDetail.md) | ☑️ | | | +| **Description** | **NullableString** | ☑️ | | | +| **Email** | **NullableString** | ☑️ | | | +| **MobileNumber** | **NullableString** | ☑️ | | | +| **PhoneNumber** | **NullableString** | ☑️ | | | +| **Addresses** | [**Address[]**](Address.md) | ☑️ | | | +| **IdentityAccounts** | [**IdentityAccountResponse[]**](IdentityAccountResponse.md) | ☑️ | | | +| **KycDocuments** | [**KYCDocumentResponse[]**](KYCDocumentResponse.md) | ☑️ | | | +| **Metadata** | **map[string]interface{}** | ☑️ | | | +| **Status** | Pointer to [**NullableEndCustomerStatus**](EndCustomerStatus.md) | | | | +| **Id** | **string** | ☑️ | | | +| **Created** | **time.Time** | ☑️ | | | +| **Updated** | **time.Time** | ☑️ | | | ## Methods diff --git a/docs/customer/CustomerRequest.md b/docs/customer/CustomerRequest.md index 65d3deb7..379a332a 100644 --- a/docs/customer/CustomerRequest.md +++ b/docs/customer/CustomerRequest.md @@ -1,22 +1,22 @@ # CustomerRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ClientName** | Pointer to **string** | Entity's name for this client | [optional] | -| **ReferenceId** | **string** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | -| **Type** | Pointer to **string** | | [optional] [default to "INDIVIDUAL"] | -| **IndividualDetail** | Pointer to [**NullableIndividualDetail**](IndividualDetail.md) | | [optional] | -| **BusinessDetail** | Pointer to [**NullableBusinessDetail**](BusinessDetail.md) | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **Email** | Pointer to **string** | | [optional] | -| **MobileNumber** | Pointer to **string** | | [optional] | -| **PhoneNumber** | Pointer to **string** | | [optional] | -| **Addresses** | Pointer to [**AddressRequest[]**](AddressRequest.md) | | [optional] | -| **IdentityAccounts** | Pointer to [**IdentityAccountRequest[]**](IdentityAccountRequest.md) | | [optional] | -| **KycDocuments** | Pointer to [**KYCDocumentRequest[]**](KYCDocumentRequest.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ClientName** | Pointer to **string** | | Entity's name for this client | | +| **ReferenceId** | **string** | ☑️ | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | +| **Type** | Pointer to **string** | | | ["INDIVIDUAL"] | +| **IndividualDetail** | Pointer to [**NullableIndividualDetail**](IndividualDetail.md) | | | | +| **BusinessDetail** | Pointer to [**NullableBusinessDetail**](BusinessDetail.md) | | | | +| **Description** | Pointer to **NullableString** | | | | +| **Email** | Pointer to **string** | | | | +| **MobileNumber** | Pointer to **string** | | | | +| **PhoneNumber** | Pointer to **string** | | | | +| **Addresses** | Pointer to [**AddressRequest[]**](AddressRequest.md) | | | | +| **IdentityAccounts** | Pointer to [**IdentityAccountRequest[]**](IdentityAccountRequest.md) | | | | +| **KycDocuments** | Pointer to [**KYCDocumentRequest[]**](KYCDocumentRequest.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/customer/EmploymentDetail.md b/docs/customer/EmploymentDetail.md index 5de9bc86..2da74efe 100644 --- a/docs/customer/EmploymentDetail.md +++ b/docs/customer/EmploymentDetail.md @@ -1,12 +1,12 @@ # EmploymentDetail -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **EmployerName** | Pointer to **NullableString** | Name of employer | [optional] | -| **NatureOfBusiness** | Pointer to **NullableString** | Industry or nature of business | [optional] | -| **RoleDescription** | Pointer to **NullableString** | Occupation or title | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **EmployerName** | Pointer to **NullableString** | | Name of employer | | +| **NatureOfBusiness** | Pointer to **NullableString** | | Industry or nature of business | | +| **RoleDescription** | Pointer to **NullableString** | | Occupation or title | | ## Methods diff --git a/docs/customer/EndCustomerStatus.md b/docs/customer/EndCustomerStatus.md index 1aa3f84b..f5886279 100644 --- a/docs/customer/EndCustomerStatus.md +++ b/docs/customer/EndCustomerStatus.md @@ -1,19 +1,19 @@ # EndCustomerStatus -## Enum - -* `ACTIVE` (value: `"ACTIVE"`) - -* `INACTIVE` (value: `"INACTIVE"`) - -* `PENDING` (value: `"PENDING"`) - -* `BLOCKED` (value: `"BLOCKED"`) - -* `DELETED` (value: `"DELETED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `ACTIVE` (value: `"ACTIVE"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `BLOCKED` (value: `"BLOCKED"`) + + * `DELETED` (value: `"DELETED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/customer/Error.md b/docs/customer/Error.md index 66feff66..db20f8db 100644 --- a/docs/customer/Error.md +++ b/docs/customer/Error.md @@ -1,12 +1,12 @@ # Error -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | | | -| **Message** | **string** | | | -| **Errors** | Pointer to **map[string]interface{}[]** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | | | +| **Message** | **string** | ☑️ | | | +| **Errors** | Pointer to **map[string]interface{}[]** | | | | ## Methods diff --git a/docs/customer/GetCustomerByReferenceID200Response.md b/docs/customer/GetCustomerByReferenceID200Response.md index 05368ae4..a1870544 100644 --- a/docs/customer/GetCustomerByReferenceID200Response.md +++ b/docs/customer/GetCustomerByReferenceID200Response.md @@ -1,11 +1,11 @@ # GetCustomerByReferenceID200Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **HasMore** | Pointer to **bool** | | [optional] | -| **Data** | Pointer to [**Customer[]**](Customer.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **HasMore** | Pointer to **bool** | | | | +| **Data** | Pointer to [**Customer[]**](Customer.md) | | | | ## Methods diff --git a/docs/customer/GetCustomerByReferenceID400Response.md b/docs/customer/GetCustomerByReferenceID400Response.md index 00a57332..1dc9373e 100644 --- a/docs/customer/GetCustomerByReferenceID400Response.md +++ b/docs/customer/GetCustomerByReferenceID400Response.md @@ -1,12 +1,12 @@ # GetCustomerByReferenceID400Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | | | -| **Message** | **interface{}** | | | -| **Errors** | Pointer to **map[string]interface{}[]** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | | | +| **Message** | **interface{}** | ☑️ | | | +| **Errors** | Pointer to **map[string]interface{}[]** | | | | ## Methods diff --git a/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md b/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md index 4db30655..9c14ff32 100644 --- a/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md +++ b/docs/customer/GetCustomerByReferenceID400ResponseAllOf.md @@ -1,11 +1,11 @@ # GetCustomerByReferenceID400ResponseAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **interface{}** | | | | ## Methods diff --git a/docs/customer/IdentityAccountRequest.md b/docs/customer/IdentityAccountRequest.md index 14aa3a00..dcad3922 100644 --- a/docs/customer/IdentityAccountRequest.md +++ b/docs/customer/IdentityAccountRequest.md @@ -1,14 +1,14 @@ # IdentityAccountRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | Pointer to [**IdentityAccountType**](IdentityAccountType.md) | | [optional] | -| **Company** | Pointer to **string** | The issuing institution associated with the account (e.g., OCBC, GOPAY, 7-11). If adding financial accounts that Xendit supports, we recommend you use the channel_name found at https://xendit.github.io/apireference/#payment-channels for this field | [optional] | -| **Description** | Pointer to **string** | Free text description of this account | [optional] | -| **Country** | Pointer to **NullableString** | ISO3166-2 country code | [optional] | -| **Properties** | Pointer to [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | Pointer to [**IdentityAccountType**](IdentityAccountType.md) | | | | +| **Company** | Pointer to **string** | | The issuing institution associated with the account (e.g., OCBC, GOPAY, 7-11). If adding financial accounts that Xendit supports, we recommend you use the channel_name found at https://xendit.github.io/apireference/#payment-channels for this field | | +| **Description** | Pointer to **string** | | Free text description of this account | | +| **Country** | Pointer to **NullableString** | | ISO3166-2 country code | | +| **Properties** | Pointer to [**IdentityAccountRequestProperties**](IdentityAccountRequestProperties.md) | | | | ## Methods diff --git a/docs/customer/IdentityAccountRequestProperties.md b/docs/customer/IdentityAccountRequestProperties.md index a0fbe8c6..9d316423 100644 --- a/docs/customer/IdentityAccountRequestProperties.md +++ b/docs/customer/IdentityAccountRequestProperties.md @@ -1,20 +1,20 @@ # IdentityAccountRequestProperties -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountNumber** | Pointer to **string** | Unique account identifier as per the bank records. | [optional] | -| **AccountHolderName** | Pointer to **NullableString** | Name of account holder as per the cardless credit account. | [optional] | -| **SwiftCode** | Pointer to **NullableString** | The SWIFT code for international payments | [optional] | -| **AccountType** | Pointer to **NullableString** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **AccountDetails** | Pointer to **NullableString** | Potentially masked account detail, for display purposes only. | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **TokenId** | Pointer to **string** | The token id returned in tokenisation | [optional] | -| **AccountId** | Pointer to **string** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | -| **PaymentCode** | Pointer to **string** | Complete fixed payment code (including prefix) | [optional] | -| **ExpiresAt** | Pointer to **NullableString** | YYYY-MM-DD string with expiry date for the payment code | [optional] | -| **QrString** | Pointer to **string** | String representation of the QR Code image | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountNumber** | Pointer to **string** | | Unique account identifier as per the bank records. | | +| **AccountHolderName** | Pointer to **NullableString** | | Name of account holder as per the cardless credit account. | | +| **SwiftCode** | Pointer to **NullableString** | | The SWIFT code for international payments | | +| **AccountType** | Pointer to **NullableString** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **AccountDetails** | Pointer to **NullableString** | | Potentially masked account detail, for display purposes only. | | +| **Currency** | Pointer to **string** | | | | +| **TokenId** | Pointer to **string** | | The token id returned in tokenisation | | +| **AccountId** | Pointer to **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | +| **PaymentCode** | Pointer to **string** | | Complete fixed payment code (including prefix) | | +| **ExpiresAt** | Pointer to **NullableString** | | YYYY-MM-DD string with expiry date for the payment code | | +| **QrString** | Pointer to **string** | | String representation of the QR Code image | | ## Methods diff --git a/docs/customer/IdentityAccountResponse.md b/docs/customer/IdentityAccountResponse.md index 75f77dcd..bd7683ce 100644 --- a/docs/customer/IdentityAccountResponse.md +++ b/docs/customer/IdentityAccountResponse.md @@ -1,18 +1,18 @@ # IdentityAccountResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | Pointer to **string** | | [optional] | -| **Code** | Pointer to **NullableString** | | [optional] | -| **Company** | **NullableString** | | | -| **Description** | **NullableString** | | | -| **Country** | **NullableString** | ISO3166-2 country code | | -| **HolderName** | Pointer to **NullableString** | | [optional] | -| **Type** | **NullableString** | | | -| **Properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | | | -| **Created** | Pointer to **time.Time** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | Pointer to **string** | | | | +| **Code** | Pointer to **NullableString** | | | | +| **Company** | **NullableString** | ☑️ | | | +| **Description** | **NullableString** | ☑️ | | | +| **Country** | **NullableString** | ☑️ | ISO3166-2 country code | | +| **HolderName** | Pointer to **NullableString** | | | | +| **Type** | **NullableString** | ☑️ | | | +| **Properties** | [**IdentityAccountResponseProperties**](IdentityAccountResponseProperties.md) | ☑️ | | | +| **Created** | Pointer to **time.Time** | | | | ## Methods diff --git a/docs/customer/IdentityAccountResponseProperties.md b/docs/customer/IdentityAccountResponseProperties.md index 28d04572..cb0e2953 100644 --- a/docs/customer/IdentityAccountResponseProperties.md +++ b/docs/customer/IdentityAccountResponseProperties.md @@ -1,20 +1,20 @@ # IdentityAccountResponseProperties -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountNumber** | Pointer to **string** | Unique account identifier as per the bank records. | [optional] | -| **AccountHolderName** | Pointer to **NullableString** | Name of account holder as per the cardless credit account. | [optional] | -| **SwiftCode** | Pointer to **NullableString** | The SWIFT code for international payments | [optional] | -| **AccountType** | Pointer to **NullableString** | Free text account type, e.g., Savings, Transaction, Virtual Account. | [optional] | -| **AccountDetails** | Pointer to **NullableString** | Potentially masked account detail, for display purposes only. | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **TokenId** | Pointer to **string** | The token id returned in tokenisation | [optional] | -| **PaymentCode** | Pointer to **string** | Complete fixed payment code (including prefix) | [optional] | -| **ExpiresAt** | Pointer to **NullableString** | YYYY-MM-DD string with expiry date for the payment code | [optional] | -| **QrString** | Pointer to **string** | String representation of the QR Code image | [optional] | -| **AccountId** | Pointer to **string** | Alphanumeric string identifying this account. Usually an email address or phone number. | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountNumber** | Pointer to **string** | | Unique account identifier as per the bank records. | | +| **AccountHolderName** | Pointer to **NullableString** | | Name of account holder as per the cardless credit account. | | +| **SwiftCode** | Pointer to **NullableString** | | The SWIFT code for international payments | | +| **AccountType** | Pointer to **NullableString** | | Free text account type, e.g., Savings, Transaction, Virtual Account. | | +| **AccountDetails** | Pointer to **NullableString** | | Potentially masked account detail, for display purposes only. | | +| **Currency** | Pointer to **string** | | | | +| **TokenId** | Pointer to **string** | | The token id returned in tokenisation | | +| **PaymentCode** | Pointer to **string** | | Complete fixed payment code (including prefix) | | +| **ExpiresAt** | Pointer to **NullableString** | | YYYY-MM-DD string with expiry date for the payment code | | +| **QrString** | Pointer to **string** | | String representation of the QR Code image | | +| **AccountId** | Pointer to **string** | | Alphanumeric string identifying this account. Usually an email address or phone number. | | ## Methods diff --git a/docs/customer/IdentityAccountType.md b/docs/customer/IdentityAccountType.md index a5b27d94..852ce494 100644 --- a/docs/customer/IdentityAccountType.md +++ b/docs/customer/IdentityAccountType.md @@ -1,21 +1,21 @@ # IdentityAccountType -## Enum - -* `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `CREDIT_CARD` (value: `"CREDIT_CARD"`) - -* `PAY_LATER` (value: `"PAY_LATER"`) - -* `OTC` (value: `"OTC"`) - -* `QR_CODE` (value: `"QR_CODE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `CREDIT_CARD` (value: `"CREDIT_CARD"`) + + * `PAY_LATER` (value: `"PAY_LATER"`) + + * `OTC` (value: `"OTC"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/customer/IndividualDetail.md b/docs/customer/IndividualDetail.md index 23dbe3a4..fcc8d6db 100644 --- a/docs/customer/IndividualDetail.md +++ b/docs/customer/IndividualDetail.md @@ -1,20 +1,20 @@ # IndividualDetail -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **GivenNames** | Pointer to **string** | | [optional] | -| **GivenNamesNonRoman** | Pointer to **NullableString** | | [optional] | -| **MiddleName** | Pointer to **NullableString** | | [optional] | -| **Surname** | Pointer to **NullableString** | | [optional] | -| **SurnameNonRoman** | Pointer to **NullableString** | | [optional] | -| **MotherMaidenName** | Pointer to **NullableString** | | [optional] | -| **Gender** | Pointer to **NullableString** | | [optional] | -| **DateOfBirth** | Pointer to **NullableString** | | [optional] | -| **Nationality** | Pointer to **NullableString** | ISO3166-2 country code | [optional] | -| **PlaceOfBirth** | Pointer to **NullableString** | | [optional] | -| **Employment** | Pointer to [**NullableEmploymentDetail**](EmploymentDetail.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **GivenNames** | Pointer to **string** | | | | +| **GivenNamesNonRoman** | Pointer to **NullableString** | | | | +| **MiddleName** | Pointer to **NullableString** | | | | +| **Surname** | Pointer to **NullableString** | | | | +| **SurnameNonRoman** | Pointer to **NullableString** | | | | +| **MotherMaidenName** | Pointer to **NullableString** | | | | +| **Gender** | Pointer to **NullableString** | | | | +| **DateOfBirth** | Pointer to **NullableString** | | | | +| **Nationality** | Pointer to **NullableString** | | ISO3166-2 country code | | +| **PlaceOfBirth** | Pointer to **NullableString** | | | | +| **Employment** | Pointer to [**NullableEmploymentDetail**](EmploymentDetail.md) | | | | ## Methods diff --git a/docs/customer/KYCDocumentRequest.md b/docs/customer/KYCDocumentRequest.md index d55c3ef3..fc52befb 100644 --- a/docs/customer/KYCDocumentRequest.md +++ b/docs/customer/KYCDocumentRequest.md @@ -1,17 +1,17 @@ # KYCDocumentRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Country** | Pointer to **NullableString** | ISO3166-2 country code | [optional] | -| **Type** | Pointer to [**KYCDocumentType**](KYCDocumentType.md) | | [optional] | -| **SubType** | Pointer to [**NullableKYCDocumentSubType**](KYCDocumentSubType.md) | | [optional] | -| **DocumentName** | Pointer to **string** | | [optional] | -| **DocumentNumber** | Pointer to **string** | | [optional] | -| **ExpiresAt** | Pointer to **string** | | [optional] | -| **HolderName** | Pointer to **string** | | [optional] | -| **DocumentImages** | Pointer to **string[]** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Country** | Pointer to **NullableString** | | ISO3166-2 country code | | +| **Type** | Pointer to [**KYCDocumentType**](KYCDocumentType.md) | | | | +| **SubType** | Pointer to [**NullableKYCDocumentSubType**](KYCDocumentSubType.md) | | | | +| **DocumentName** | Pointer to **string** | | | | +| **DocumentNumber** | Pointer to **string** | | | | +| **ExpiresAt** | Pointer to **string** | | | | +| **HolderName** | Pointer to **string** | | | | +| **DocumentImages** | Pointer to **string[]** | | | | ## Methods diff --git a/docs/customer/KYCDocumentResponse.md b/docs/customer/KYCDocumentResponse.md index 27f5357a..bccb756a 100644 --- a/docs/customer/KYCDocumentResponse.md +++ b/docs/customer/KYCDocumentResponse.md @@ -1,17 +1,17 @@ # KYCDocumentResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Country** | **string** | | | -| **Type** | [**KYCDocumentType**](KYCDocumentType.md) | | | -| **SubType** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | | | -| **DocumentName** | **NullableString** | | | -| **DocumentNumber** | **NullableString** | | | -| **ExpiresAt** | **NullableString** | | | -| **HolderName** | **NullableString** | | | -| **DocumentImages** | **string[]** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Country** | **string** | ☑️ | | | +| **Type** | [**KYCDocumentType**](KYCDocumentType.md) | ☑️ | | | +| **SubType** | [**KYCDocumentSubType**](KYCDocumentSubType.md) | ☑️ | | | +| **DocumentName** | **NullableString** | ☑️ | | | +| **DocumentNumber** | **NullableString** | ☑️ | | | +| **ExpiresAt** | **NullableString** | ☑️ | | | +| **HolderName** | **NullableString** | ☑️ | | | +| **DocumentImages** | **string[]** | ☑️ | | | ## Methods diff --git a/docs/customer/KYCDocumentSubType.md b/docs/customer/KYCDocumentSubType.md index 698365f3..3f122b9b 100644 --- a/docs/customer/KYCDocumentSubType.md +++ b/docs/customer/KYCDocumentSubType.md @@ -1,29 +1,29 @@ # KYCDocumentSubType -## Enum - -* `NATIONAL_ID` (value: `"NATIONAL_ID"`) - -* `CONSULAR_ID` (value: `"CONSULAR_ID"`) - -* `VOTER_ID` (value: `"VOTER_ID"`) - -* `POSTAL_ID` (value: `"POSTAL_ID"`) - -* `RESIDENCE_PERMIT` (value: `"RESIDENCE_PERMIT"`) - -* `TAX_ID` (value: `"TAX_ID"`) - -* `STUDENT_ID` (value: `"STUDENT_ID"`) - -* `MILITARY_ID` (value: `"MILITARY_ID"`) - -* `MEDICAL_ID` (value: `"MEDICAL_ID"`) - -* `OTHERS` (value: `"OTHERS"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `NATIONAL_ID` (value: `"NATIONAL_ID"`) + + * `CONSULAR_ID` (value: `"CONSULAR_ID"`) + + * `VOTER_ID` (value: `"VOTER_ID"`) + + * `POSTAL_ID` (value: `"POSTAL_ID"`) + + * `RESIDENCE_PERMIT` (value: `"RESIDENCE_PERMIT"`) + + * `TAX_ID` (value: `"TAX_ID"`) + + * `STUDENT_ID` (value: `"STUDENT_ID"`) + + * `MILITARY_ID` (value: `"MILITARY_ID"`) + + * `MEDICAL_ID` (value: `"MEDICAL_ID"`) + + * `OTHERS` (value: `"OTHERS"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/customer/KYCDocumentType.md b/docs/customer/KYCDocumentType.md index 241aba09..d3dfb40f 100644 --- a/docs/customer/KYCDocumentType.md +++ b/docs/customer/KYCDocumentType.md @@ -1,25 +1,25 @@ # KYCDocumentType -## Enum - -* `BIRTH_CERTIFICATE` (value: `"BIRTH_CERTIFICATE"`) - -* `BANK_STATEMENT` (value: `"BANK_STATEMENT"`) - -* `DRIVING_LICENSE` (value: `"DRIVING_LICENSE"`) - -* `IDENTITY_CARD` (value: `"IDENTITY_CARD"`) - -* `PASSPORT` (value: `"PASSPORT"`) - -* `VISA` (value: `"VISA"`) - -* `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) - -* `BUSINESS_LICENSE` (value: `"BUSINESS_LICENSE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `BIRTH_CERTIFICATE` (value: `"BIRTH_CERTIFICATE"`) + + * `BANK_STATEMENT` (value: `"BANK_STATEMENT"`) + + * `DRIVING_LICENSE` (value: `"DRIVING_LICENSE"`) + + * `IDENTITY_CARD` (value: `"IDENTITY_CARD"`) + + * `PASSPORT` (value: `"PASSPORT"`) + + * `VISA` (value: `"VISA"`) + + * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) + + * `BUSINESS_LICENSE` (value: `"BUSINESS_LICENSE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/customer/PatchCustomer.md b/docs/customer/PatchCustomer.md index cff91706..910d90e6 100644 --- a/docs/customer/PatchCustomer.md +++ b/docs/customer/PatchCustomer.md @@ -1,22 +1,22 @@ # PatchCustomer -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ClientName** | Pointer to **NullableString** | Entity's name for this client | [optional] | -| **ReferenceId** | Pointer to **NullableString** | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | [optional] | -| **IndividualDetail** | Pointer to [**NullableIndividualDetail**](IndividualDetail.md) | | [optional] | -| **BusinessDetail** | Pointer to [**NullableBusinessDetail**](BusinessDetail.md) | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **Email** | Pointer to **NullableString** | | [optional] | -| **MobileNumber** | Pointer to **NullableString** | | [optional] | -| **PhoneNumber** | Pointer to **NullableString** | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | -| **Addresses** | Pointer to [**AddressRequest[]**](AddressRequest.md) | | [optional] | -| **IdentityAccounts** | Pointer to [**IdentityAccountRequest[]**](IdentityAccountRequest.md) | | [optional] | -| **KycDocuments** | Pointer to [**KYCDocumentRequest[]**](KYCDocumentRequest.md) | | [optional] | -| **Status** | Pointer to [**NullableEndCustomerStatus**](EndCustomerStatus.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ClientName** | Pointer to **NullableString** | | Entity's name for this client | | +| **ReferenceId** | Pointer to **NullableString** | | Merchant's reference of this end customer, eg Merchant's user's id. Must be unique. | | +| **IndividualDetail** | Pointer to [**NullableIndividualDetail**](IndividualDetail.md) | | | | +| **BusinessDetail** | Pointer to [**NullableBusinessDetail**](BusinessDetail.md) | | | | +| **Description** | Pointer to **NullableString** | | | | +| **Email** | Pointer to **NullableString** | | | | +| **MobileNumber** | Pointer to **NullableString** | | | | +| **PhoneNumber** | Pointer to **NullableString** | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | +| **Addresses** | Pointer to [**AddressRequest[]**](AddressRequest.md) | | | | +| **IdentityAccounts** | Pointer to [**IdentityAccountRequest[]**](IdentityAccountRequest.md) | | | | +| **KycDocuments** | Pointer to [**KYCDocumentRequest[]**](KYCDocumentRequest.md) | | | | +| **Status** | Pointer to [**NullableEndCustomerStatus**](EndCustomerStatus.md) | | | | ## Methods diff --git a/docs/customer/ResponseDataNotFound.md b/docs/customer/ResponseDataNotFound.md index 3a9064d4..10e7d482 100644 --- a/docs/customer/ResponseDataNotFound.md +++ b/docs/customer/ResponseDataNotFound.md @@ -1,11 +1,11 @@ # ResponseDataNotFound -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **interface{}** | | | | ## Methods diff --git a/docs/customer/UpdateCustomer400Response.md b/docs/customer/UpdateCustomer400Response.md index 34511f38..e5502a95 100644 --- a/docs/customer/UpdateCustomer400Response.md +++ b/docs/customer/UpdateCustomer400Response.md @@ -1,12 +1,12 @@ # UpdateCustomer400Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | | | -| **Message** | **interface{}** | | | -| **Errors** | Pointer to **map[string]interface{}[]** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | | | +| **Message** | **interface{}** | ☑️ | | | +| **Errors** | Pointer to **map[string]interface{}[]** | | | | ## Methods diff --git a/docs/customer/UpdateCustomer400ResponseAllOf.md b/docs/customer/UpdateCustomer400ResponseAllOf.md index d48ba8c1..80dbf9c1 100644 --- a/docs/customer/UpdateCustomer400ResponseAllOf.md +++ b/docs/customer/UpdateCustomer400ResponseAllOf.md @@ -1,11 +1,11 @@ # UpdateCustomer400ResponseAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **interface{}** | | | | ## Methods diff --git a/docs/invoice.yaml b/docs/invoice.yaml deleted file mode 100644 index 264e4b27..00000000 --- a/docs/invoice.yaml +++ /dev/null @@ -1,1466 +0,0 @@ -openapi: 3.0.0 -info: - description: xendit-invoice-service descriptions - title: xendit-invoice-service - version: 1.5.0 -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /v2/invoices/: - post: - operationId: createInvoice - parameters: - - description: Business ID of the sub-account merchant (XP feature) - explode: false - in: header - name: for-user-id - required: false - schema: - example: 62efe4c33e45694d63f585f8 - type: string - style: simple - requestBody: - content: - application/json: - examples: - Create Invoice Request: - value: - external_id: test1234 - description: Test Invoice - amount: 10000 - invoice_duration: 172800 - currency: IDR - reminder_time: 1 - schema: - $ref: '#/components/schemas/CreateInvoiceRequest' - required: true - responses: - "200": - content: - application/json: - examples: - Successfully created Invoice: - $ref: '#/components/examples/InvoiceExample' - value: null - schema: - $ref: '#/components/schemas/Invoice' - description: OK - "400": - content: - application/json: - examples: - Maximum Transfer Amount Error: - value: - error_code: MAXIMUM_TRANSFER_AMOUNT_ERROR - message: "The maximum amount for using this payment is ${currency}\ - \ 5,000,000" - No Collections Method Error: - value: - error_code: NO_COLLECTION_METHODS_ERROR - message: Could not create invoice without any active payment channels - Email Format Error: - summary: EMAIL_FORMAT_ERROR - value: - error_code: EMAIL_FORMAT_ERROR - message: Customer email format is invalid - Unavailable Payment Error: - value: - error_code: UNAVAILABLE_PAYMENT_METHOD_ERROR - message: The payment method choices did not match with the available - one on this business - Unsupported Currency Error: - value: - error_code: UNSUPPORTED_CURRENCY - message: The payment currency request is not supported for this - payment channel - Currency Mismatch Error: - summary: Invoice settings not found for this currency' - value: - error_code: MISMATCH_CURRENCY_ERROR - message: "" - Invalid Remind Time Error: - value: - error_code: INVALID_REMINDER_TIME - message: The reminder time is invalid - Invoice Amount Mismatch: - value: - error_code: INVOICE_AMOUNT_MISMATCHED_CLOSED_VA_EXPECTED_AMOUNT - message: Could not create invoice due to invoice amount is not - match with Closed VA expected amount." - schema: - $ref: '#/components/schemas/BadRequestError' - description: Bad request - "401": - content: - application/json: - examples: - Invalid API Key: - $ref: '#/components/examples/InvalidApiKeyExample' - value: null - schema: - $ref: '#/components/schemas/UnauthorizedError' - description: Unauthorized - "403": - content: - application/json: - examples: - Access Suspended: - $ref: '#/components/examples/AccessSuspendedErrorExample' - value: null - schema: - $ref: '#/components/schemas/ForbiddenError' - description: Forbidden - "404": - content: - application/json: - examples: - Callback Virtual Account Error: - value: - error_code: CALLBACK_VIRTUAL_ACCOUNT_NOT_FOUND_ERROR - message: Could not find callback virtual account - Unique Account Number Error: - value: - error_code: UNIQUE_ACCOUNT_NUMBER_UNAVAILABLE_ERROR - message: There is no available virtual account in your non-fixed - virtual account range - Payment Code Not Available: - value: - error_code: PAYMENT_CODE_NOT_AVAILABLE_ERROR - message: No more vacant space for convenience store code - schema: - $ref: '#/components/schemas/InvoiceNotFoundError' - description: Not found - security: - - {} - summary: Create an invoice - tags: - - invoice - /v2/invoices/{invoice_id}: - get: - operationId: getInvoiceById - parameters: - - description: Business ID of the sub-account merchant (XP feature) - explode: false - in: header - name: for-user-id - required: false - schema: - example: 62efe4c33e45694d63f585f8 - type: string - style: simple - - description: Invoice ID - explode: false - in: path - name: invoice_id - required: true - schema: - example: 62efe4c33e45294d63f585f2 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Invoice' - description: OK - "401": - content: - application/json: - examples: - Invalid API Key: - $ref: '#/components/examples/InvalidApiKeyExample' - value: null - schema: - $ref: '#/components/schemas/UnauthorizedError' - description: Unauthorized - "404": - content: - application/json: - examples: - Invoice not found: - $ref: '#/components/examples/InvoiceNotFoundErrorExample' - value: null - schema: - $ref: '#/components/schemas/InvoiceError404ResponseDefinition' - description: Not found - "500": - content: - application/json: - examples: - Internal Server error: - $ref: '#/components/examples/ServerErrorExample' - value: null - schema: - $ref: '#/components/schemas/ServerError' - description: Internal server error - security: - - {} - summary: Get invoice by invoice id - tags: - - invoice - /v2/invoices: - get: - operationId: getInvoices - parameters: - - description: Business ID of the sub-account merchant (XP feature) - explode: false - in: header - name: for-user-id - required: false - schema: - example: 62efe4c33e45694d63f585f8 - type: string - style: simple - - explode: true - in: query - name: external_id - required: false - schema: - example: test-external - type: string - style: form - - explode: true - in: query - name: statuses - required: false - schema: - example: - - PENDING - - SETTLED - items: - $ref: '#/components/schemas/InvoiceStatus' - type: array - style: form - - explode: true - in: query - name: limit - required: false - schema: - example: 10 - type: number - style: form - - explode: true - in: query - name: created_after - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: created_before - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: paid_after - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: paid_before - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: expired_after - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: expired_before - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: last_invoice - required: false - schema: - example: 62efe4c33e45294d63f585f2 - type: string - style: form - - explode: true - in: query - name: client_types - required: false - schema: - example: - - API_GATEWAY - - DASHBOARD - items: - $ref: '#/components/schemas/InvoiceClientType' - type: array - style: form - - explode: true - in: query - name: payment_channels - required: false - schema: - example: - - BNI - - BRI - items: - type: string - type: array - style: form - - explode: true - in: query - name: on_demand_link - required: false - schema: - example: test-link - type: string - style: form - - explode: true - in: query - name: recurring_payment_id - required: false - schema: - example: 62efe4c33e45294d63f585f2 - type: string - style: form - responses: - "200": - content: - application/json: - schema: - items: - $ref: '#/components/schemas/Invoice' - type: array - description: OK - "401": - content: - application/json: - examples: - INVALID_API_KEY: - summary: INVALID_API_KEY - value: - error_code: INVALID_API_KEY - message: Your API key is invalid - schema: - $ref: '#/components/schemas/UnauthorizedError' - description: Unauthorized - "500": - content: - application/json: - examples: - Internal Server error: - $ref: '#/components/examples/ServerErrorExample' - value: null - schema: - $ref: '#/components/schemas/ServerError' - description: Internal server error - security: - - {} - summary: Get all Invoices - tags: - - invoice - /invoices/{invoice_id}/expire!: - post: - operationId: expireInvoice - parameters: - - description: Business ID of the sub-account merchant (XP feature) - explode: false - in: header - name: for-user-id - required: false - schema: - example: 62efe4c33e45694d63f585f8 - type: string - style: simple - - description: Invoice ID to be expired - explode: false - in: path - name: invoice_id - required: true - schema: - example: 5f4708b7bd394b0400b96276 - type: string - style: simple - responses: - "200": - content: - application/json: - examples: - Successfully expire Invoice: - $ref: '#/components/examples/InvoiceExample' - value: null - schema: - $ref: '#/components/schemas/Invoice' - description: OK - "404": - content: - application/json: - examples: - Invoice not found: - $ref: '#/components/examples/InvoiceNotFoundErrorExample' - value: null - schema: - $ref: '#/components/schemas/InvoiceNotFoundError' - description: Not found - "500": - content: - application/json: - examples: - Internal Server error: - $ref: '#/components/examples/ServerErrorExample' - value: null - schema: - $ref: '#/components/schemas/ServerError' - description: Internal server error - security: - - {} - summary: Manually expire an invoice - tags: - - invoice -components: - examples: - InvoiceExample: - summary: Example of Invoice - value: - id: 64e44c42cf6ba3554184a337 - external_id: invoice-1692683329 - user_id: 5f4708b7bd394b0400b96276 - status: PENDING - merchant_name: Boxify - merchant_profile_picture_url: https://xnd-companies.s3.amazonaws.com/prod/1633484308963_880.jpg - amount: 1800000 - payer_email: customer@domain.com - description: "Invoice Demo #123" - expiry_date: 2023-08-22T07:48:50.150Z - invoice_url: https://checkout-staging.xendit.co/v2/64e44c42cf6ba3554184a337 - available_banks: - - bank_code: MANDIRI - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BRI - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BNI - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: PERMATA - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BCA - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BSI - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BJB - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: CIMB - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: SAHABAT_SAMPOERNA - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - - bank_code: BNC - collection_type: POOL - transfer_amount: 1800000 - bank_branch: Virtual Account - account_holder_name: BOXIFY - available_retail_outlets: - - retail_outlet_name: ALFAMART - - retail_outlet_name: INDOMARET - available_ewallets: - - ewallet_type: OVO - - ewallet_type: DANA - - ewallet_type: SHOPEEPAY - - ewallet_type: LINKAJA - - ewallet_type: ASTRAPAY - - ewallet_type: NEXCASH - - ewallet_type: JENIUSPAY - available_qr_codes: - - qr_code_type: QRIS - available_direct_debits: - - direct_debit_type: DD_BRI - - direct_debit_type: DD_BCA_KLIKPAY - - direct_debit_type: DD_MANDIRI - available_paylaters: - - paylater_type: KREDIVO - - paylater_type: UANGME - - paylater_type: AKULAKU - - paylater_type: ATOME - should_exclude_credit_card: false - should_send_email: false - created: 2023-08-22T05:48:51.105Z - updated: 2023-08-22T05:48:51.105Z - currency: IDR - reminder_date: 2023-08-22T06:48:50.150Z - customer_notification_preference: - invoice_created: - - email - invoice_paid: - - email - InvalidApiKeyExample: - summary: Example of Invalid API Key error - value: - error_code: INVALID_API_KEY - message: Your API key is invalid - AccessSuspendedErrorExample: - summary: Example of Access Suspended error - value: - error_code: ACCESS_SUSPENDED - message: "Access to API has been suspended temporarily due to indication of\ - \ fraudulent activities. If you believe this is inaccurate, kindly contact\ - \ our Customer Success for resolution." - InvoiceNotFoundErrorExample: - summary: Example of Invoice not found error - value: - error_code: INVOICE_NOT_FOUND_ERROR - message: Invoice not found. - ServerErrorExample: - summary: Example of Server Error - value: - error_code: INTERNAL_SERVER_ERROR - message: Something unxpected happened. - parameters: - ForUserId: - description: Business ID of the sub-account merchant (XP feature) - explode: false - in: header - name: for-user-id - required: false - schema: - example: 62efe4c33e45694d63f585f8 - type: string - style: simple - schemas: - UnauthorizedError: - description: An error object used to indicate unauthorized access to an invoice-related - resource. - properties: - error_code: - description: The specific error code associated with the unauthorized access. - enum: - - INVALID_API_KEY - type: string - message: - description: A human-readable error message providing additional context - about the unauthorized access. - type: string - required: - - error_code - - message - type: object - ForbiddenError: - description: An error object used to indicate a 403 Forbidden response related - to invoice operations. - properties: - error_code: - description: The specific error code indicating that access to the invoice - operation is suspended. - enum: - - ACCESS_SUSPENDED - type: string - message: - description: A human-readable error message providing additional context - about the 403 Forbidden response. - type: string - required: - - error_code - - message - type: object - InvoiceError404ResponseDefinition: - description: "An error object used to indicate that the requested resource,\ - \ in this case, an invoice, was not found." - properties: - error_code: - description: The specific error code indicating that the requested invoice - was not found. - enum: - - INVOICE_NOT_FOUND_ERROR - type: string - message: - description: A human-readable error message providing additional context - about the resource not being found. - type: string - required: - - error_code - - message - type: object - Datetime: - description: Representing a date and time in ISO 8601 format. - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - NotificationChannel: - description: Representing a notification channel for sending messages. - enum: - - email - - sms - - whatsapp - - viber - type: string - InvoiceStatus: - description: Representing the status of an invoice. - enum: - - PENDING - - PAID - - SETTLED - - EXPIRED - type: string - InvoiceCurrency: - description: Representing the currency used for an invoice. - enum: - - IDR - - USD - - THB - - VND - - PHP - type: string - InvoiceClientType: - description: Representing the client type or source of an invoice. - enum: - - DASHBOARD - - API_GATEWAY - - INTEGRATION - - ON_DEMAND - - RECURRING - - MOBILE - type: string - InvoicePaymentMethod: - description: Representing the payment method used for an invoice. - enum: - - POOL - - CALLBACK_VIRTUAL_ACCOUNT - - CREDIT_CARD - - RETAIL_OUTLET - - QR_CODE - - QRIS - - EWALLET - - DIRECT_DEBIT - - BANK_TRANSFER - - PAYLATER - type: string - BankCode: - description: Representing the available bank channels used for invoice-related - transactions. - enum: - - BCA - - BNI - - BRI - - MANDIRI - - PERMATA - - BSI - - BJB - - SAHABAT_SAMPOERNA - - CIMB - - BNC - type: string - RetailOutletName: - description: Representing the available retail outlet channels used for invoice-related - transactions. - enum: - - ALFAMART - - INDOMARET - - 7ELEVEN - - CEBUANA - - DP_ECPAY_LOAN - - DP_MLHUILLIER - - DP_PALAWAN - - DP_ECPAY_SCHOOL - - LBC - type: string - EwalletType: - description: Representing the available eWallet channels used for invoice-related - transactions. - enum: - - OVO - - DANA - - LINKAJA - - PAYMAYA - - SHOPEEPAY - - GCASH - - GRABPAY - - ASTRAPAY - - NEXCASH - - JENIUSPAY - type: string - QrCodeType: - description: Representing the available QR Code channels used for invoice-related - transactions. - enum: - - QRIS - - PROMPTPAY - type: string - DirectDebitType: - description: Representing the available Direct Debit channels used for invoice-related - transactions. - enum: - - BA_BRI - - DC_BRI - - DD_BRI - - DD_MANDIRI - - BA_BPI - - DC_BPI - - DD_BPI - - BA_UBP - - DC_UBP - - DD_UBP - - BCA_KLIKPAY - - BA_BCA_KLIKPAY - - DC_BCA_KLIKPAY - - DD_BCA_KLIKPAY - - DD_BDO_EPAY - - DD_RCBC - - DD_CHINABANK - - BA_CHINABANK - - DC_CHINABANK - type: string - PaylaterType: - description: Representing the available paylater channels used for invoice-related - transactions. - enum: - - KREDIVO - - AKULAKU - - UANGME - - BILLEASE - - CASHALO - - ATOME - type: string - AddressObject: - description: An object representing an address with various properties. - example: - country: country - province: province - city: city - street_line2: street_line2 - street_line1: street_line1 - state: state - postal_code: postal_code - properties: - country: - description: The country where the address is located. - nullable: true - type: string - street_line1: - description: The first line of the street address. - nullable: true - type: string - street_line2: - description: The second line of the street address. - nullable: true - type: string - city: - description: The city or locality within the address. - nullable: true - type: string - province: - description: The province or region within the country. - nullable: true - type: string - state: - description: The state or administrative division within the country. - nullable: true - type: string - postal_code: - description: The postal code or ZIP code for the address. - nullable: true - type: string - type: object - CustomerObject: - description: "An object representing a customer with various properties, including\ - \ addresses." - example: - addresses: - - country: country - province: province - city: city - street_line2: street_line2 - street_line1: street_line1 - state: state - postal_code: postal_code - - country: country - province: province - city: city - street_line2: street_line2 - street_line1: street_line1 - state: state - postal_code: postal_code - surname: surname - phone_number: phone_number - id: id - given_names: given_names - mobile_number: mobile_number - customer_id: customer_id - email: email - properties: - id: - description: The unique identifier for the customer. - nullable: true - type: string - phone_number: - description: The customer's phone number. - nullable: true - type: string - given_names: - description: The customer's given names or first names. - nullable: true - type: string - surname: - description: The customer's surname or last name. - nullable: true - type: string - email: - description: The customer's email address. - nullable: true - type: string - mobile_number: - description: The customer's mobile phone number. - nullable: true - type: string - customer_id: - description: An additional identifier for the customer. - nullable: true - type: string - addresses: - description: An array of addresses associated with the customer. - items: - $ref: '#/components/schemas/AddressObject' - nullable: true - type: array - type: object - NotificationPreference: - description: An object representing notification preferences for different invoice - events. - example: - invoice_expired: - - null - - null - invoice_paid: - - null - - null - invoice_reminder: - - null - - null - invoice_created: - - null - - null - properties: - invoice_created: - description: Notification channels for when an invoice is created. - items: - $ref: '#/components/schemas/NotificationChannel' - type: array - invoice_reminder: - description: Notification channels for invoice reminders. - items: - $ref: '#/components/schemas/NotificationChannel' - type: array - invoice_expired: - description: Notification channels for expired invoices. - items: - $ref: '#/components/schemas/NotificationChannel' - type: array - invoice_paid: - description: Notification channels for when an invoice is paid. - items: - $ref: '#/components/schemas/NotificationChannel' - type: array - type: object - AlternativeDisplayItem: - description: An object representing alternative display of a VA. - example: - type: type - value: value - properties: - type: - description: Represent type of alternative display. - type: string - value: - description: Represent value of alternative display value. - type: string - type: object - Bank: - description: An object representing bank details for invoices. - example: - bank_code: null - bank_branch: bank_branch - bank_account_number: bank_account_number - transfer_amount: 6.027456183070403 - account_holder_name: account_holder_name - alternative_displays: - - type: type - value: value - - type: type - value: value - collection_type: collection_type - properties: - bank_code: - $ref: '#/components/schemas/BankCode' - collection_type: - description: The collection type for the bank details. - type: string - bank_branch: - description: The branch of the bank. - type: string - bank_account_number: - description: The bank account number. - type: string - account_holder_name: - description: The name of the account holder. - type: string - transfer_amount: - description: The transfer amount. - type: number - alternative_displays: - items: - $ref: '#/components/schemas/AlternativeDisplayItem' - type: array - required: - - account_holder_name - - bank_code - - collection_type - type: object - RetailOutlet: - description: An object representing retail outlet details for invoices. - example: - retail_outlet_name: null - transfer_amount: 1.4658129805029452 - merchant_name: merchant_name - payment_code: payment_code - properties: - retail_outlet_name: - $ref: '#/components/schemas/RetailOutletName' - payment_code: - description: The payment code. - type: string - transfer_amount: - description: The transfer amount. - type: number - merchant_name: - description: The name of the merchant. - type: string - required: - - retail_outlet_name - type: object - Ewallet: - description: An object representing e-wallet details for invoices. - example: - ewallet_type: null - properties: - ewallet_type: - $ref: '#/components/schemas/EwalletType' - required: - - ewallet_type - type: object - QrCode: - description: An object representing QR code details for invoices. - example: - qr_code_type: null - properties: - qr_code_type: - $ref: '#/components/schemas/QrCodeType' - required: - - qr_code_type - type: object - DirectDebit: - description: An object representing direct debit details for invoices. - example: - direct_debit_type: null - properties: - direct_debit_type: - $ref: '#/components/schemas/DirectDebitType' - required: - - direct_debit_type - type: object - Paylater: - description: An object representing paylater details for invoices. - example: - paylater_type: null - should_exclude: true - properties: - paylater_type: - $ref: '#/components/schemas/PaylaterType' - should_exclude: - description: Indicates whether this paylater option should be excluded. - type: boolean - required: - - paylater_type - type: object - InvoiceItem: - description: An object representing an item within an invoice. - example: - quantity: 0.5637376656633328 - reference_id: reference_id - price: 5.962133916683182 - name: name - category: category - url: url - properties: - name: - description: The name of the item. - type: string - price: - description: The price of the item. - type: number - quantity: - description: The quantity of the item. Must be greater than or equal to - 0. - exclusiveMinimum: true - minimum: 0 - type: number - reference_id: - description: The reference ID of the item. - type: string - url: - description: The URL associated with the item. - type: string - category: - description: The category of the item. - type: string - required: - - name - - price - - quantity - type: object - InvoiceFee: - description: An object representing internal details for a fee associated with - an invoice. - example: - type: type - value: 2.3021358869347655 - properties: - type: - description: The type of fee. - type: string - value: - description: The value or amount of the fee. - type: number - required: - - type - - value - type: object - Invoice: - description: An object representing details for an invoice. - example: - available_paylaters: - - paylater_type: null - should_exclude: true - - paylater_type: null - should_exclude: true - fees: - - type: type - value: 2.3021358869347655 - - type: type - value: 2.3021358869347655 - payer_email: payer_email - reminder_date: 2016-08-29T09:12:33.001Z - description: description - external_id: external_id - locale: locale - should_send_email: true - customer_notification_preference: - invoice_expired: - - null - - null - invoice_paid: - - null - - null - invoice_reminder: - - null - - null - invoice_created: - - null - - null - currency: null - id: id - failure_redirect_url: failure_redirect_url - payment_method: null - amount: 0.8008281904610115 - available_banks: - - bank_code: null - bank_branch: bank_branch - bank_account_number: bank_account_number - transfer_amount: 6.027456183070403 - account_holder_name: account_holder_name - alternative_displays: - - type: type - value: value - - type: type - value: value - collection_type: collection_type - - bank_code: null - bank_branch: bank_branch - bank_account_number: bank_account_number - transfer_amount: 6.027456183070403 - account_holder_name: account_holder_name - alternative_displays: - - type: type - value: value - - type: type - value: value - collection_type: collection_type - available_ewallets: - - ewallet_type: null - - ewallet_type: null - available_retail_outlets: - - retail_outlet_name: null - transfer_amount: 1.4658129805029452 - merchant_name: merchant_name - payment_code: payment_code - - retail_outlet_name: null - transfer_amount: 1.4658129805029452 - merchant_name: merchant_name - payment_code: payment_code - created: 2016-08-29T09:12:33.001Z - expiry_date: 2016-08-29T09:12:33.001Z - merchant_name: merchant_name - available_qr_codes: - - qr_code_type: null - - qr_code_type: null - available_direct_debits: - - direct_debit_type: null - - direct_debit_type: null - merchant_profile_picture_url: merchant_profile_picture_url - should_authenticate_credit_card: true - user_id: user_id - success_redirect_url: success_redirect_url - should_exclude_credit_card: true - updated: 2016-08-29T09:12:33.001Z - items: - - quantity: 0.5637376656633328 - reference_id: reference_id - price: 5.962133916683182 - name: name - category: category - url: url - - quantity: 0.5637376656633328 - reference_id: reference_id - price: 5.962133916683182 - name: name - category: category - url: url - invoice_url: invoice_url - status: null - fixed_va: true - customer: - addresses: - - country: country - province: province - city: city - street_line2: street_line2 - street_line1: street_line1 - state: state - postal_code: postal_code - - country: country - province: province - city: city - street_line2: street_line2 - street_line1: street_line1 - state: state - postal_code: postal_code - surname: surname - phone_number: phone_number - id: id - given_names: given_names - mobile_number: mobile_number - customer_id: customer_id - email: email - properties: - id: - description: The unique identifier for the invoice. - type: string - external_id: - description: The external identifier for the invoice. - type: string - user_id: - description: The user ID associated with the invoice. - type: string - payer_email: - description: The email address of the payer. - type: string - description: - description: A description of the invoice. - type: string - payment_method: - $ref: '#/components/schemas/InvoicePaymentMethod' - status: - $ref: '#/components/schemas/InvoiceStatus' - merchant_name: - description: The name of the merchant. - type: string - merchant_profile_picture_url: - description: The URL of the merchant's profile picture. - type: string - locale: - description: The locale or language used for the invoice. - type: string - amount: - description: The total amount of the invoice. - type: number - expiry_date: - description: Representing a date and time in ISO 8601 format. - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - invoice_url: - description: The URL to view the invoice. - type: string - available_banks: - description: An array of available banks for payment. - items: - $ref: '#/components/schemas/Bank' - type: array - available_retail_outlets: - description: An array of available retail outlets for payment. - items: - $ref: '#/components/schemas/RetailOutlet' - type: array - available_ewallets: - description: An array of available e-wallets for payment. - items: - $ref: '#/components/schemas/Ewallet' - type: array - available_qr_codes: - description: An array of available QR codes for payment. - items: - $ref: '#/components/schemas/QrCode' - type: array - available_direct_debits: - description: An array of available direct debit options for payment. - items: - $ref: '#/components/schemas/DirectDebit' - type: array - available_paylaters: - description: An array of available pay-later options for payment. - items: - $ref: '#/components/schemas/Paylater' - type: array - should_exclude_credit_card: - description: Indicates whether credit card payments should be excluded. - type: boolean - should_send_email: - description: Indicates whether email notifications should be sent. - type: boolean - created: - description: Representing a date and time in ISO 8601 format. - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - updated: - description: Representing a date and time in ISO 8601 format. - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - success_redirect_url: - description: The URL to redirect to on successful payment. - type: string - failure_redirect_url: - description: The URL to redirect to on payment failure. - type: string - should_authenticate_credit_card: - description: Indicates whether credit card authentication is required. - type: boolean - currency: - $ref: '#/components/schemas/InvoiceCurrency' - items: - description: An array of items included in the invoice. - items: - $ref: '#/components/schemas/InvoiceItem' - type: array - fixed_va: - description: Indicates whether the virtual account is fixed. - type: boolean - reminder_date: - description: Representing a date and time in ISO 8601 format. - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - customer: - $ref: '#/components/schemas/CustomerObject' - customer_notification_preference: - $ref: '#/components/schemas/NotificationPreference' - fees: - description: An array of fees associated with the invoice. - items: - $ref: '#/components/schemas/InvoiceFee' - type: array - required: - - amount - - available_banks - - available_direct_debits - - available_ewallets - - available_paylaters - - available_qr_codes - - available_retail_outlets - - created - - expiry_date - - external_id - - invoice_url - - merchant_name - - merchant_profile_picture_url - - should_send_email - - status - - status_updated - - updated - - user_id - type: object - CreateInvoiceRequest: - description: An object representing for an invoice creation request. - example: - external_id: invoice-external-id-1 - amount: 10000 - description: Payment for PSN subscription - properties: - external_id: - description: The external ID of the invoice. - type: string - amount: - description: The invoice amount. - type: number - payer_email: - description: The email address of the payer. - type: string - description: - description: A description of the payment. - type: string - invoice_duration: - description: The duration of the invoice. - type: string - callback_virtual_account_id: - description: The ID of the callback virtual account. - type: string - should_send_email: - description: Indicates whether email notifications should be sent. - type: boolean - customer: - $ref: '#/components/schemas/CustomerObject' - customer_notification_preference: - $ref: '#/components/schemas/NotificationPreference' - success_redirect_url: - description: The URL to redirect to on successful payment. - type: string - failure_redirect_url: - description: The URL to redirect to on payment failure. - type: string - payment_methods: - description: An array of available payment methods. - items: - type: string - type: array - mid_label: - description: The middle label. - type: string - should_authenticate_credit_card: - description: Indicates whether credit card authentication is required. - type: boolean - currency: - description: The currency of the invoice. - type: string - reminder_time: - description: The reminder time. - type: number - local: - description: The local. - type: string - reminder_time_unit: - description: The unit of the reminder time. - type: string - items: - description: An array of items included in the invoice. - items: - $ref: '#/components/schemas/InvoiceItem' - type: array - fees: - description: An array of fees associated with the invoice. - items: - $ref: '#/components/schemas/InvoiceFee' - type: array - required: - - amount - - external_id - type: object - BadRequestError: - description: Response definition for a 400 Bad Request error when creating an - invoice. - properties: - error_code: - description: The error code indicating the type of error that occurred. - enum: - - MAXIMUM_TRANSFER_AMOUNT_ERROR - - NO_COLLECTION_METHODS_ERROR - - EMAIL_FORMAT_ERROR - - UNAVAILABLE_PAYMENT_METHOD_ERROR - - UNSUPPORTED_CURRENCY - - MISMATCH_CURRENCY_ERROR - - INVALID_REMINDER_TIME - type: string - message: - description: A human-readable error message that provides additional information - about the error. - type: string - required: - - error_code - - message - type: object - InvoiceNotFoundError: - description: Response definition for a 404 Not Found error when creating an - invoice. - properties: - error_code: - description: The error code indicating the type of error that occurred. - enum: - - CALLBACK_VIRTUAL_ACCOUNT_NOT_FOUND_ERROR - - UNIQUE_ACCOUNT_NUMBER_UNAVAILABLE_ERROR - - PAYMENT_CODE_NOT_AVAILABLE_ERROR - type: string - message: - description: A human-readable error message that provides additional information - about the error. - type: string - required: - - error_code - - message - type: object - ServerError: - properties: - error_code: - enum: - - SERVER_ERROR - type: string - message: - type: string - required: - - error_code - - message - type: object - securitySchemes: - ApiKeyAuth: - in: header - name: x-api-key - type: apiKey diff --git a/docs/invoice/AddressObject.md b/docs/invoice/AddressObject.md index 22fb2f08..429eba9d 100644 --- a/docs/invoice/AddressObject.md +++ b/docs/invoice/AddressObject.md @@ -1,16 +1,16 @@ # AddressObject +An object representing an address with various properties. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Country** | Pointer to **NullableString** | The country where the address is located. | [optional] | -| **StreetLine1** | Pointer to **NullableString** | The first line of the street address. | [optional] | -| **StreetLine2** | Pointer to **NullableString** | The second line of the street address. | [optional] | -| **City** | Pointer to **NullableString** | The city or locality within the address. | [optional] | -| **Province** | Pointer to **NullableString** | The province or region within the country. | [optional] | -| **State** | Pointer to **NullableString** | The state or administrative division within the country. | [optional] | -| **PostalCode** | Pointer to **NullableString** | The postal code or ZIP code for the address. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Country** | Pointer to **NullableString** | | The country where the address is located. | | +| **StreetLine1** | Pointer to **NullableString** | | The first line of the street address. | | +| **StreetLine2** | Pointer to **NullableString** | | The second line of the street address. | | +| **City** | Pointer to **NullableString** | | The city or locality within the address. | | +| **Province** | Pointer to **NullableString** | | The province or region within the country. | | +| **State** | Pointer to **NullableString** | | The state or administrative division within the country. | | +| **PostalCode** | Pointer to **NullableString** | | The postal code or ZIP code for the address. | | ## Methods diff --git a/docs/invoice/AlternativeDisplayItem.md b/docs/invoice/AlternativeDisplayItem.md index 080ba2ed..5ed10e2a 100644 --- a/docs/invoice/AlternativeDisplayItem.md +++ b/docs/invoice/AlternativeDisplayItem.md @@ -1,11 +1,11 @@ # AlternativeDisplayItem +An object representing alternative display of a VA. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | Pointer to **string** | Represent type of alternative display. | [optional] | -| **Value** | Pointer to **string** | Represent value of alternative display value. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | Pointer to **string** | | Represent type of alternative display. | | +| **Value** | Pointer to **string** | | Represent value of alternative display value. | | ## Methods diff --git a/docs/invoice/BadRequestError.md b/docs/invoice/BadRequestError.md index 72e527b2..11aa4cf9 100644 --- a/docs/invoice/BadRequestError.md +++ b/docs/invoice/BadRequestError.md @@ -1,11 +1,11 @@ # BadRequestError +Response definition for a 400 Bad Request error when creating an invoice. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | The error code indicating the type of error that occurred. | | -| **Message** | **string** | A human-readable error message that provides additional information about the error. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | The error code indicating the type of error that occurred. | | +| **Message** | **string** | ☑️ | A human-readable error message that provides additional information about the error. | | ## Methods diff --git a/docs/invoice/Bank.md b/docs/invoice/Bank.md index 1573cfe3..78534d1c 100644 --- a/docs/invoice/Bank.md +++ b/docs/invoice/Bank.md @@ -1,16 +1,16 @@ # Bank +An object representing bank details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **BankCode** | [**BankCode**](BankCode.md) | | | -| **CollectionType** | **string** | The collection type for the bank details. | | -| **BankBranch** | Pointer to **string** | The branch of the bank. | [optional] | -| **BankAccountNumber** | Pointer to **string** | The bank account number. | [optional] | -| **AccountHolderName** | **string** | The name of the account holder. | | -| **TransferAmount** | Pointer to **float32** | The transfer amount. | [optional] | -| **AlternativeDisplays** | Pointer to [**AlternativeDisplayItem[]**](AlternativeDisplayItem.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **BankCode** | [**BankCode**](BankCode.md) | ☑️ | | | +| **CollectionType** | **string** | ☑️ | The collection type for the bank details. | | +| **BankBranch** | Pointer to **string** | | The branch of the bank. | | +| **BankAccountNumber** | Pointer to **string** | | The bank account number. | | +| **AccountHolderName** | **string** | ☑️ | The name of the account holder. | | +| **TransferAmount** | Pointer to **float32** | | The transfer amount. | | +| **AlternativeDisplays** | Pointer to [**AlternativeDisplayItem[]**](AlternativeDisplayItem.md) | | | | ## Methods diff --git a/docs/invoice/BankCode.md b/docs/invoice/BankCode.md index b94e7247..74426e7a 100644 --- a/docs/invoice/BankCode.md +++ b/docs/invoice/BankCode.md @@ -1,29 +1,29 @@ # BankCode - -## Enum - - -* `BCA` (value: `"BCA"`) - -* `BNI` (value: `"BNI"`) - -* `BRI` (value: `"BRI"`) - -* `MANDIRI` (value: `"MANDIRI"`) - -* `PERMATA` (value: `"PERMATA"`) - -* `BSI` (value: `"BSI"`) - -* `BJB` (value: `"BJB"`) - -* `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) - -* `CIMB` (value: `"CIMB"`) - -* `BNC` (value: `"BNC"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available bank channels used for invoice-related transactions. + + ## Enum + + * `BCA` (value: `"BCA"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `BJB` (value: `"BJB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `CIMB` (value: `"CIMB"`) + + * `BNC` (value: `"BNC"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/CreateInvoiceRequest.md b/docs/invoice/CreateInvoiceRequest.md index c6efb8c8..ecb3379b 100644 --- a/docs/invoice/CreateInvoiceRequest.md +++ b/docs/invoice/CreateInvoiceRequest.md @@ -1,29 +1,29 @@ # CreateInvoiceRequest +An object representing for an invoice creation request. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ExternalId** | **string** | The external ID of the invoice. | | -| **Amount** | **float32** | The invoice amount. | | -| **PayerEmail** | Pointer to **string** | The email address of the payer. | [optional] | -| **Description** | Pointer to **string** | A description of the payment. | [optional] | -| **InvoiceDuration** | Pointer to **string** | The duration of the invoice. | [optional] | -| **CallbackVirtualAccountId** | Pointer to **string** | The ID of the callback virtual account. | [optional] | -| **ShouldSendEmail** | Pointer to **bool** | Indicates whether email notifications should be sent. | [optional] | -| **Customer** | Pointer to [**CustomerObject**](CustomerObject.md) | | [optional] | -| **CustomerNotificationPreference** | Pointer to [**NotificationPreference**](NotificationPreference.md) | | [optional] | -| **SuccessRedirectUrl** | Pointer to **string** | The URL to redirect to on successful payment. | [optional] | -| **FailureRedirectUrl** | Pointer to **string** | The URL to redirect to on payment failure. | [optional] | -| **PaymentMethods** | Pointer to **string[]** | An array of available payment methods. | [optional] | -| **MidLabel** | Pointer to **string** | The middle label. | [optional] | -| **ShouldAuthenticateCreditCard** | Pointer to **bool** | Indicates whether credit card authentication is required. | [optional] | -| **Currency** | Pointer to **string** | The currency of the invoice. | [optional] | -| **ReminderTime** | Pointer to **float32** | The reminder time. | [optional] | -| **Local** | Pointer to **string** | The local. | [optional] | -| **ReminderTimeUnit** | Pointer to **string** | The unit of the reminder time. | [optional] | -| **Items** | Pointer to [**InvoiceItem[]**](InvoiceItem.md) | An array of items included in the invoice. | [optional] | -| **Fees** | Pointer to [**InvoiceFee[]**](InvoiceFee.md) | An array of fees associated with the invoice. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ExternalId** | **string** | ☑️ | The external ID of the invoice. | | +| **Amount** | **float32** | ☑️ | The invoice amount. | | +| **PayerEmail** | Pointer to **string** | | The email address of the payer. | | +| **Description** | Pointer to **string** | | A description of the payment. | | +| **InvoiceDuration** | Pointer to **string** | | The duration of the invoice. | | +| **CallbackVirtualAccountId** | Pointer to **string** | | The ID of the callback virtual account. | | +| **ShouldSendEmail** | Pointer to **bool** | | Indicates whether email notifications should be sent. | | +| **Customer** | Pointer to [**CustomerObject**](CustomerObject.md) | | | | +| **CustomerNotificationPreference** | Pointer to [**NotificationPreference**](NotificationPreference.md) | | | | +| **SuccessRedirectUrl** | Pointer to **string** | | The URL to redirect to on successful payment. | | +| **FailureRedirectUrl** | Pointer to **string** | | The URL to redirect to on payment failure. | | +| **PaymentMethods** | Pointer to **string[]** | | An array of available payment methods. | | +| **MidLabel** | Pointer to **string** | | The middle label. | | +| **ShouldAuthenticateCreditCard** | Pointer to **bool** | | Indicates whether credit card authentication is required. | | +| **Currency** | Pointer to **string** | | The currency of the invoice. | | +| **ReminderTime** | Pointer to **float32** | | The reminder time. | | +| **Local** | Pointer to **string** | | The local. | | +| **ReminderTimeUnit** | Pointer to **string** | | The unit of the reminder time. | | +| **Items** | Pointer to [**InvoiceItem[]**](InvoiceItem.md) | | An array of items included in the invoice. | | +| **Fees** | Pointer to [**InvoiceFee[]**](InvoiceFee.md) | | An array of fees associated with the invoice. | | ## Methods diff --git a/docs/invoice/CustomerObject.md b/docs/invoice/CustomerObject.md index d5e3dcba..7a786d29 100644 --- a/docs/invoice/CustomerObject.md +++ b/docs/invoice/CustomerObject.md @@ -1,17 +1,17 @@ # CustomerObject +An object representing a customer with various properties, including addresses. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | Pointer to **NullableString** | The unique identifier for the customer. | [optional] | -| **PhoneNumber** | Pointer to **NullableString** | The customer's phone number. | [optional] | -| **GivenNames** | Pointer to **NullableString** | The customer's given names or first names. | [optional] | -| **Surname** | Pointer to **NullableString** | The customer's surname or last name. | [optional] | -| **Email** | Pointer to **NullableString** | The customer's email address. | [optional] | -| **MobileNumber** | Pointer to **NullableString** | The customer's mobile phone number. | [optional] | -| **CustomerId** | Pointer to **NullableString** | An additional identifier for the customer. | [optional] | -| **Addresses** | Pointer to [**AddressObject[]**](AddressObject.md) | An array of addresses associated with the customer. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | Pointer to **NullableString** | | The unique identifier for the customer. | | +| **PhoneNumber** | Pointer to **NullableString** | | The customer's phone number. | | +| **GivenNames** | Pointer to **NullableString** | | The customer's given names or first names. | | +| **Surname** | Pointer to **NullableString** | | The customer's surname or last name. | | +| **Email** | Pointer to **NullableString** | | The customer's email address. | | +| **MobileNumber** | Pointer to **NullableString** | | The customer's mobile phone number. | | +| **CustomerId** | Pointer to **NullableString** | | An additional identifier for the customer. | | +| **Addresses** | Pointer to [**AddressObject[]**](AddressObject.md) | | An array of addresses associated with the customer. | | ## Methods diff --git a/docs/invoice/DirectDebit.md b/docs/invoice/DirectDebit.md index 2e70e313..9863558a 100644 --- a/docs/invoice/DirectDebit.md +++ b/docs/invoice/DirectDebit.md @@ -1,10 +1,10 @@ # DirectDebit +An object representing direct debit details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **DirectDebitType** | [**DirectDebitType**](DirectDebitType.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **DirectDebitType** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | ## Methods diff --git a/docs/invoice/DirectDebitType.md b/docs/invoice/DirectDebitType.md index 0d68c20d..242e5419 100644 --- a/docs/invoice/DirectDebitType.md +++ b/docs/invoice/DirectDebitType.md @@ -1,47 +1,47 @@ # DirectDebitType - -## Enum - - -* `BA_BRI` (value: `"BA_BRI"`) - -* `DC_BRI` (value: `"DC_BRI"`) - -* `DD_BRI` (value: `"DD_BRI"`) - -* `DD_MANDIRI` (value: `"DD_MANDIRI"`) - -* `BA_BPI` (value: `"BA_BPI"`) - -* `DC_BPI` (value: `"DC_BPI"`) - -* `DD_BPI` (value: `"DD_BPI"`) - -* `BA_UBP` (value: `"BA_UBP"`) - -* `DC_UBP` (value: `"DC_UBP"`) - -* `DD_UBP` (value: `"DD_UBP"`) - -* `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) - -* `BA_BCA_KLIKPAY` (value: `"BA_BCA_KLIKPAY"`) - -* `DC_BCA_KLIKPAY` (value: `"DC_BCA_KLIKPAY"`) - -* `DD_BCA_KLIKPAY` (value: `"DD_BCA_KLIKPAY"`) - -* `DD_BDO_EPAY` (value: `"DD_BDO_EPAY"`) - -* `DD_RCBC` (value: `"DD_RCBC"`) - -* `DD_CHINABANK` (value: `"DD_CHINABANK"`) - -* `BA_CHINABANK` (value: `"BA_CHINABANK"`) - -* `DC_CHINABANK` (value: `"DC_CHINABANK"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available Direct Debit channels used for invoice-related transactions. + + ## Enum + + * `BA_BRI` (value: `"BA_BRI"`) + + * `DC_BRI` (value: `"DC_BRI"`) + + * `DD_BRI` (value: `"DD_BRI"`) + + * `DD_MANDIRI` (value: `"DD_MANDIRI"`) + + * `BA_BPI` (value: `"BA_BPI"`) + + * `DC_BPI` (value: `"DC_BPI"`) + + * `DD_BPI` (value: `"DD_BPI"`) + + * `BA_UBP` (value: `"BA_UBP"`) + + * `DC_UBP` (value: `"DC_UBP"`) + + * `DD_UBP` (value: `"DD_UBP"`) + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BA_BCA_KLIKPAY` (value: `"BA_BCA_KLIKPAY"`) + + * `DC_BCA_KLIKPAY` (value: `"DC_BCA_KLIKPAY"`) + + * `DD_BCA_KLIKPAY` (value: `"DD_BCA_KLIKPAY"`) + + * `DD_BDO_EPAY` (value: `"DD_BDO_EPAY"`) + + * `DD_RCBC` (value: `"DD_RCBC"`) + + * `DD_CHINABANK` (value: `"DD_CHINABANK"`) + + * `BA_CHINABANK` (value: `"BA_CHINABANK"`) + + * `DC_CHINABANK` (value: `"DC_CHINABANK"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/Ewallet.md b/docs/invoice/Ewallet.md index 5f9f66b6..448c5467 100644 --- a/docs/invoice/Ewallet.md +++ b/docs/invoice/Ewallet.md @@ -1,10 +1,10 @@ # Ewallet +An object representing e-wallet details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **EwalletType** | [**EwalletType**](EwalletType.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **EwalletType** | [**EwalletType**](EwalletType.md) | ☑️ | | | ## Methods diff --git a/docs/invoice/EwalletType.md b/docs/invoice/EwalletType.md index 363e0e38..bf507f98 100644 --- a/docs/invoice/EwalletType.md +++ b/docs/invoice/EwalletType.md @@ -1,29 +1,29 @@ # EwalletType - -## Enum - - -* `OVO` (value: `"OVO"`) - -* `DANA` (value: `"DANA"`) - -* `LINKAJA` (value: `"LINKAJA"`) - -* `PAYMAYA` (value: `"PAYMAYA"`) - -* `SHOPEEPAY` (value: `"SHOPEEPAY"`) - -* `GCASH` (value: `"GCASH"`) - -* `GRABPAY` (value: `"GRABPAY"`) - -* `ASTRAPAY` (value: `"ASTRAPAY"`) - -* `NEXCASH` (value: `"NEXCASH"`) - -* `JENIUSPAY` (value: `"JENIUSPAY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available eWallet channels used for invoice-related transactions. + + ## Enum + + * `OVO` (value: `"OVO"`) + + * `DANA` (value: `"DANA"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/ForbiddenError.md b/docs/invoice/ForbiddenError.md index 6ecfeb6e..941191f7 100644 --- a/docs/invoice/ForbiddenError.md +++ b/docs/invoice/ForbiddenError.md @@ -1,11 +1,11 @@ # ForbiddenError +An error object used to indicate a 403 Forbidden response related to invoice operations. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | The specific error code indicating that access to the invoice operation is suspended. | | -| **Message** | **string** | A human-readable error message providing additional context about the 403 Forbidden response. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | The specific error code indicating that access to the invoice operation is suspended. | | +| **Message** | **string** | ☑️ | A human-readable error message providing additional context about the 403 Forbidden response. | | ## Methods diff --git a/docs/invoice/Invoice.md b/docs/invoice/Invoice.md index eff88d54..2da8516e 100644 --- a/docs/invoice/Invoice.md +++ b/docs/invoice/Invoice.md @@ -1,42 +1,42 @@ # Invoice +An object representing details for an invoice. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | Pointer to **string** | The unique identifier for the invoice. | [optional] | -| **ExternalId** | **string** | The external identifier for the invoice. | | -| **UserId** | **string** | The user ID associated with the invoice. | | -| **PayerEmail** | Pointer to **string** | The email address of the payer. | [optional] | -| **Description** | Pointer to **string** | A description of the invoice. | [optional] | -| **PaymentMethod** | Pointer to [**InvoicePaymentMethod**](InvoicePaymentMethod.md) | | [optional] | -| **Status** | [**InvoiceStatus**](InvoiceStatus.md) | | | -| **MerchantName** | **string** | The name of the merchant. | | -| **MerchantProfilePictureUrl** | **string** | The URL of the merchant's profile picture. | | -| **Locale** | Pointer to **string** | The locale or language used for the invoice. | [optional] | -| **Amount** | **float32** | The total amount of the invoice. | | -| **ExpiryDate** | **time.Time** | Representing a date and time in ISO 8601 format. | | -| **InvoiceUrl** | **string** | The URL to view the invoice. | | -| **AvailableBanks** | [**Bank[]**](Bank.md) | An array of available banks for payment. | | -| **AvailableRetailOutlets** | [**RetailOutlet[]**](RetailOutlet.md) | An array of available retail outlets for payment. | | -| **AvailableEwallets** | [**Ewallet[]**](Ewallet.md) | An array of available e-wallets for payment. | | -| **AvailableQrCodes** | [**QrCode[]**](QrCode.md) | An array of available QR codes for payment. | | -| **AvailableDirectDebits** | [**DirectDebit[]**](DirectDebit.md) | An array of available direct debit options for payment. | | -| **AvailablePaylaters** | [**Paylater[]**](Paylater.md) | An array of available pay-later options for payment. | | -| **ShouldExcludeCreditCard** | Pointer to **bool** | Indicates whether credit card payments should be excluded. | [optional] | -| **ShouldSendEmail** | **bool** | Indicates whether email notifications should be sent. | | -| **Created** | **time.Time** | Representing a date and time in ISO 8601 format. | | -| **Updated** | **time.Time** | Representing a date and time in ISO 8601 format. | | -| **SuccessRedirectUrl** | Pointer to **string** | The URL to redirect to on successful payment. | [optional] | -| **FailureRedirectUrl** | Pointer to **string** | The URL to redirect to on payment failure. | [optional] | -| **ShouldAuthenticateCreditCard** | Pointer to **bool** | Indicates whether credit card authentication is required. | [optional] | -| **Currency** | Pointer to [**InvoiceCurrency**](InvoiceCurrency.md) | | [optional] | -| **Items** | Pointer to [**InvoiceItem[]**](InvoiceItem.md) | An array of items included in the invoice. | [optional] | -| **FixedVa** | Pointer to **bool** | Indicates whether the virtual account is fixed. | [optional] | -| **ReminderDate** | Pointer to **time.Time** | Representing a date and time in ISO 8601 format. | [optional] | -| **Customer** | Pointer to [**CustomerObject**](CustomerObject.md) | | [optional] | -| **CustomerNotificationPreference** | Pointer to [**NotificationPreference**](NotificationPreference.md) | | [optional] | -| **Fees** | Pointer to [**InvoiceFee[]**](InvoiceFee.md) | An array of fees associated with the invoice. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | Pointer to **string** | | The unique identifier for the invoice. | | +| **ExternalId** | **string** | ☑️ | The external identifier for the invoice. | | +| **UserId** | **string** | ☑️ | The user ID associated with the invoice. | | +| **PayerEmail** | Pointer to **string** | | The email address of the payer. | | +| **Description** | Pointer to **string** | | A description of the invoice. | | +| **PaymentMethod** | Pointer to [**InvoicePaymentMethod**](InvoicePaymentMethod.md) | | | | +| **Status** | [**InvoiceStatus**](InvoiceStatus.md) | ☑️ | | | +| **MerchantName** | **string** | ☑️ | The name of the merchant. | | +| **MerchantProfilePictureUrl** | **string** | ☑️ | The URL of the merchant's profile picture. | | +| **Locale** | Pointer to **string** | | The locale or language used for the invoice. | | +| **Amount** | **float32** | ☑️ | The total amount of the invoice. | | +| **ExpiryDate** | **time.Time** | ☑️ | Representing a date and time in ISO 8601 format. | | +| **InvoiceUrl** | **string** | ☑️ | The URL to view the invoice. | | +| **AvailableBanks** | [**Bank[]**](Bank.md) | ☑️ | An array of available banks for payment. | | +| **AvailableRetailOutlets** | [**RetailOutlet[]**](RetailOutlet.md) | ☑️ | An array of available retail outlets for payment. | | +| **AvailableEwallets** | [**Ewallet[]**](Ewallet.md) | ☑️ | An array of available e-wallets for payment. | | +| **AvailableQrCodes** | [**QrCode[]**](QrCode.md) | ☑️ | An array of available QR codes for payment. | | +| **AvailableDirectDebits** | [**DirectDebit[]**](DirectDebit.md) | ☑️ | An array of available direct debit options for payment. | | +| **AvailablePaylaters** | [**Paylater[]**](Paylater.md) | ☑️ | An array of available pay-later options for payment. | | +| **ShouldExcludeCreditCard** | Pointer to **bool** | | Indicates whether credit card payments should be excluded. | | +| **ShouldSendEmail** | **bool** | ☑️ | Indicates whether email notifications should be sent. | | +| **Created** | **time.Time** | ☑️ | Representing a date and time in ISO 8601 format. | | +| **Updated** | **time.Time** | ☑️ | Representing a date and time in ISO 8601 format. | | +| **SuccessRedirectUrl** | Pointer to **string** | | The URL to redirect to on successful payment. | | +| **FailureRedirectUrl** | Pointer to **string** | | The URL to redirect to on payment failure. | | +| **ShouldAuthenticateCreditCard** | Pointer to **bool** | | Indicates whether credit card authentication is required. | | +| **Currency** | Pointer to [**InvoiceCurrency**](InvoiceCurrency.md) | | | | +| **Items** | Pointer to [**InvoiceItem[]**](InvoiceItem.md) | | An array of items included in the invoice. | | +| **FixedVa** | Pointer to **bool** | | Indicates whether the virtual account is fixed. | | +| **ReminderDate** | Pointer to **time.Time** | | Representing a date and time in ISO 8601 format. | | +| **Customer** | Pointer to [**CustomerObject**](CustomerObject.md) | | | | +| **CustomerNotificationPreference** | Pointer to [**NotificationPreference**](NotificationPreference.md) | | | | +| **Fees** | Pointer to [**InvoiceFee[]**](InvoiceFee.md) | | An array of fees associated with the invoice. | | ## Methods diff --git a/docs/invoice/InvoiceClientType.md b/docs/invoice/InvoiceClientType.md index 694517a1..2fd7dafc 100644 --- a/docs/invoice/InvoiceClientType.md +++ b/docs/invoice/InvoiceClientType.md @@ -1,21 +1,21 @@ # InvoiceClientType - -## Enum - - -* `DASHBOARD` (value: `"DASHBOARD"`) - -* `API_GATEWAY` (value: `"API_GATEWAY"`) - -* `INTEGRATION` (value: `"INTEGRATION"`) - -* `ON_DEMAND` (value: `"ON_DEMAND"`) - -* `RECURRING` (value: `"RECURRING"`) - -* `MOBILE` (value: `"MOBILE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the client type or source of an invoice. + + ## Enum + + * `DASHBOARD` (value: `"DASHBOARD"`) + + * `API_GATEWAY` (value: `"API_GATEWAY"`) + + * `INTEGRATION` (value: `"INTEGRATION"`) + + * `ON_DEMAND` (value: `"ON_DEMAND"`) + + * `RECURRING` (value: `"RECURRING"`) + + * `MOBILE` (value: `"MOBILE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/InvoiceCurrency.md b/docs/invoice/InvoiceCurrency.md index 0955bd6c..28565a27 100644 --- a/docs/invoice/InvoiceCurrency.md +++ b/docs/invoice/InvoiceCurrency.md @@ -1,19 +1,19 @@ # InvoiceCurrency - -## Enum - - -* `IDR` (value: `"IDR"`) - -* `USD` (value: `"USD"`) - -* `THB` (value: `"THB"`) - -* `VND` (value: `"VND"`) - -* `PHP` (value: `"PHP"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the currency used for an invoice. + + ## Enum + + * `IDR` (value: `"IDR"`) + + * `USD` (value: `"USD"`) + + * `THB` (value: `"THB"`) + + * `VND` (value: `"VND"`) + + * `PHP` (value: `"PHP"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/InvoiceError404ResponseDefinition.md b/docs/invoice/InvoiceError404ResponseDefinition.md index 40ed5de4..b1b1a808 100644 --- a/docs/invoice/InvoiceError404ResponseDefinition.md +++ b/docs/invoice/InvoiceError404ResponseDefinition.md @@ -1,11 +1,11 @@ # InvoiceError404ResponseDefinition +An error object used to indicate that the requested resource, in this case, an invoice, was not found. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | The specific error code indicating that the requested invoice was not found. | | -| **Message** | **string** | A human-readable error message providing additional context about the resource not being found. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | The specific error code indicating that the requested invoice was not found. | | +| **Message** | **string** | ☑️ | A human-readable error message providing additional context about the resource not being found. | | ## Methods diff --git a/docs/invoice/InvoiceFee.md b/docs/invoice/InvoiceFee.md index 5bad6d59..4731b0fd 100644 --- a/docs/invoice/InvoiceFee.md +++ b/docs/invoice/InvoiceFee.md @@ -1,11 +1,11 @@ # InvoiceFee +An object representing internal details for a fee associated with an invoice. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | **string** | The type of fee. | | -| **Value** | **float32** | The value or amount of the fee. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | **string** | ☑️ | The type of fee. | | +| **Value** | **float32** | ☑️ | The value or amount of the fee. | | ## Methods diff --git a/docs/invoice/InvoiceItem.md b/docs/invoice/InvoiceItem.md index eba66f95..f6694118 100644 --- a/docs/invoice/InvoiceItem.md +++ b/docs/invoice/InvoiceItem.md @@ -1,15 +1,15 @@ # InvoiceItem +An object representing an item within an invoice. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Name** | **string** | The name of the item. | | -| **Price** | **float32** | The price of the item. | | -| **Quantity** | **float32** | The quantity of the item. Must be greater than or equal to 0. | | -| **ReferenceId** | Pointer to **string** | The reference ID of the item. | [optional] | -| **Url** | Pointer to **string** | The URL associated with the item. | [optional] | -| **Category** | Pointer to **string** | The category of the item. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Name** | **string** | ☑️ | The name of the item. | | +| **Price** | **float32** | ☑️ | The price of the item. | | +| **Quantity** | **float32** | ☑️ | The quantity of the item. Must be greater than or equal to 0. | | +| **ReferenceId** | Pointer to **string** | | The reference ID of the item. | | +| **Url** | Pointer to **string** | | The URL associated with the item. | | +| **Category** | Pointer to **string** | | The category of the item. | | ## Methods diff --git a/docs/invoice/InvoiceNotFoundError.md b/docs/invoice/InvoiceNotFoundError.md index e500677a..1266398b 100644 --- a/docs/invoice/InvoiceNotFoundError.md +++ b/docs/invoice/InvoiceNotFoundError.md @@ -1,11 +1,11 @@ # InvoiceNotFoundError +Response definition for a 404 Not Found error when creating an invoice. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | The error code indicating the type of error that occurred. | | -| **Message** | **string** | A human-readable error message that provides additional information about the error. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | The error code indicating the type of error that occurred. | | +| **Message** | **string** | ☑️ | A human-readable error message that provides additional information about the error. | | ## Methods diff --git a/docs/invoice/InvoicePaymentMethod.md b/docs/invoice/InvoicePaymentMethod.md index 0589b8cf..85e32b18 100644 --- a/docs/invoice/InvoicePaymentMethod.md +++ b/docs/invoice/InvoicePaymentMethod.md @@ -1,29 +1,29 @@ # InvoicePaymentMethod - -## Enum - - -* `POOL` (value: `"POOL"`) - -* `CALLBACK_VIRTUAL_ACCOUNT` (value: `"CALLBACK_VIRTUAL_ACCOUNT"`) - -* `CREDIT_CARD` (value: `"CREDIT_CARD"`) - -* `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) - -* `QR_CODE` (value: `"QR_CODE"`) - -* `QRIS` (value: `"QRIS"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) - -* `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) - -* `PAYLATER` (value: `"PAYLATER"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the payment method used for an invoice. + + ## Enum + + * `POOL` (value: `"POOL"`) + + * `CALLBACK_VIRTUAL_ACCOUNT` (value: `"CALLBACK_VIRTUAL_ACCOUNT"`) + + * `CREDIT_CARD` (value: `"CREDIT_CARD"`) + + * `RETAIL_OUTLET` (value: `"RETAIL_OUTLET"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `QRIS` (value: `"QRIS"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) + + * `PAYLATER` (value: `"PAYLATER"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/InvoiceStatus.md b/docs/invoice/InvoiceStatus.md index 2d672c00..72e14d1b 100644 --- a/docs/invoice/InvoiceStatus.md +++ b/docs/invoice/InvoiceStatus.md @@ -1,17 +1,17 @@ # InvoiceStatus - -## Enum - - -* `PENDING` (value: `"PENDING"`) - -* `PAID` (value: `"PAID"`) - -* `SETTLED` (value: `"SETTLED"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the status of an invoice. + + ## Enum + + * `PENDING` (value: `"PENDING"`) + + * `PAID` (value: `"PAID"`) + + * `SETTLED` (value: `"SETTLED"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/NotificationChannel.md b/docs/invoice/NotificationChannel.md index 024a2e7e..9f7256c1 100644 --- a/docs/invoice/NotificationChannel.md +++ b/docs/invoice/NotificationChannel.md @@ -1,17 +1,17 @@ # NotificationChannel - -## Enum - - -* `EMAIL` (value: `"email"`) - -* `SMS` (value: `"sms"`) - -* `WHATSAPP` (value: `"whatsapp"`) - -* `VIBER` (value: `"viber"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing a notification channel for sending messages. + + ## Enum + + * `EMAIL` (value: `"email"`) + + * `SMS` (value: `"sms"`) + + * `WHATSAPP` (value: `"whatsapp"`) + + * `VIBER` (value: `"viber"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/NotificationPreference.md b/docs/invoice/NotificationPreference.md index d23d33c3..c90303ba 100644 --- a/docs/invoice/NotificationPreference.md +++ b/docs/invoice/NotificationPreference.md @@ -1,13 +1,13 @@ # NotificationPreference +An object representing notification preferences for different invoice events. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **InvoiceCreated** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | Notification channels for when an invoice is created. | [optional] | -| **InvoiceReminder** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | Notification channels for invoice reminders. | [optional] | -| **InvoiceExpired** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | Notification channels for expired invoices. | [optional] | -| **InvoicePaid** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | Notification channels for when an invoice is paid. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **InvoiceCreated** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | | Notification channels for when an invoice is created. | | +| **InvoiceReminder** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | | Notification channels for invoice reminders. | | +| **InvoiceExpired** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | | Notification channels for expired invoices. | | +| **InvoicePaid** | Pointer to [**NotificationChannel[]**](NotificationChannel.md) | | Notification channels for when an invoice is paid. | | ## Methods diff --git a/docs/invoice/Paylater.md b/docs/invoice/Paylater.md index c8fa41e4..08b4b98c 100644 --- a/docs/invoice/Paylater.md +++ b/docs/invoice/Paylater.md @@ -1,11 +1,11 @@ # Paylater +An object representing paylater details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **PaylaterType** | [**PaylaterType**](PaylaterType.md) | | | -| **ShouldExclude** | Pointer to **bool** | Indicates whether this paylater option should be excluded. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **PaylaterType** | [**PaylaterType**](PaylaterType.md) | ☑️ | | | +| **ShouldExclude** | Pointer to **bool** | | Indicates whether this paylater option should be excluded. | | ## Methods diff --git a/docs/invoice/PaylaterType.md b/docs/invoice/PaylaterType.md index bc7ca05c..2f6b67f7 100644 --- a/docs/invoice/PaylaterType.md +++ b/docs/invoice/PaylaterType.md @@ -1,21 +1,21 @@ # PaylaterType - -## Enum - - -* `KREDIVO` (value: `"KREDIVO"`) - -* `AKULAKU` (value: `"AKULAKU"`) - -* `UANGME` (value: `"UANGME"`) - -* `BILLEASE` (value: `"BILLEASE"`) - -* `CASHALO` (value: `"CASHALO"`) - -* `ATOME` (value: `"ATOME"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available paylater channels used for invoice-related transactions. + + ## Enum + + * `KREDIVO` (value: `"KREDIVO"`) + + * `AKULAKU` (value: `"AKULAKU"`) + + * `UANGME` (value: `"UANGME"`) + + * `BILLEASE` (value: `"BILLEASE"`) + + * `CASHALO` (value: `"CASHALO"`) + + * `ATOME` (value: `"ATOME"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/QrCode.md b/docs/invoice/QrCode.md index 118975e9..08887631 100644 --- a/docs/invoice/QrCode.md +++ b/docs/invoice/QrCode.md @@ -1,10 +1,10 @@ # QrCode +An object representing QR code details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **QrCodeType** | [**QrCodeType**](QrCodeType.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **QrCodeType** | [**QrCodeType**](QrCodeType.md) | ☑️ | | | ## Methods diff --git a/docs/invoice/QrCodeType.md b/docs/invoice/QrCodeType.md index 8e3ef846..2c48ecdd 100644 --- a/docs/invoice/QrCodeType.md +++ b/docs/invoice/QrCodeType.md @@ -1,13 +1,13 @@ # QrCodeType - -## Enum - - -* `QRIS` (value: `"QRIS"`) - -* `PROMPTPAY` (value: `"PROMPTPAY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available QR Code channels used for invoice-related transactions. + + ## Enum + + * `QRIS` (value: `"QRIS"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/RetailOutlet.md b/docs/invoice/RetailOutlet.md index 1ecbadb0..0119ed23 100644 --- a/docs/invoice/RetailOutlet.md +++ b/docs/invoice/RetailOutlet.md @@ -1,13 +1,13 @@ # RetailOutlet +An object representing retail outlet details for invoices. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **RetailOutletName** | [**RetailOutletName**](RetailOutletName.md) | | | -| **PaymentCode** | Pointer to **string** | The payment code. | [optional] | -| **TransferAmount** | Pointer to **float32** | The transfer amount. | [optional] | -| **MerchantName** | Pointer to **string** | The name of the merchant. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **RetailOutletName** | [**RetailOutletName**](RetailOutletName.md) | ☑️ | | | +| **PaymentCode** | Pointer to **string** | | The payment code. | | +| **TransferAmount** | Pointer to **float32** | | The transfer amount. | | +| **MerchantName** | Pointer to **string** | | The name of the merchant. | | ## Methods diff --git a/docs/invoice/RetailOutletName.md b/docs/invoice/RetailOutletName.md index 35214c65..2718d8d4 100644 --- a/docs/invoice/RetailOutletName.md +++ b/docs/invoice/RetailOutletName.md @@ -1,27 +1,27 @@ # RetailOutletName - -## Enum - - -* `ALFAMART` (value: `"ALFAMART"`) - -* `INDOMARET` (value: `"INDOMARET"`) - -* `_7_ELEVEN` (value: `"7ELEVEN"`) - -* `CEBUANA` (value: `"CEBUANA"`) - -* `DP_ECPAY_LOAN` (value: `"DP_ECPAY_LOAN"`) - -* `DP_MLHUILLIER` (value: `"DP_MLHUILLIER"`) - -* `DP_PALAWAN` (value: `"DP_PALAWAN"`) - -* `DP_ECPAY_SCHOOL` (value: `"DP_ECPAY_SCHOOL"`) - -* `LBC` (value: `"LBC"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Representing the available retail outlet channels used for invoice-related transactions. + + ## Enum + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `_7_ELEVEN` (value: `"7ELEVEN"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `DP_ECPAY_LOAN` (value: `"DP_ECPAY_LOAN"`) + + * `DP_MLHUILLIER` (value: `"DP_MLHUILLIER"`) + + * `DP_PALAWAN` (value: `"DP_PALAWAN"`) + + * `DP_ECPAY_SCHOOL` (value: `"DP_ECPAY_SCHOOL"`) + + * `LBC` (value: `"LBC"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/invoice/ServerError.md b/docs/invoice/ServerError.md index 3bcdf350..3fc255a7 100644 --- a/docs/invoice/ServerError.md +++ b/docs/invoice/ServerError.md @@ -1,11 +1,11 @@ # ServerError -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | | | -| **Message** | **string** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | | | +| **Message** | **string** | ☑️ | | | ## Methods diff --git a/docs/invoice/UnauthorizedError.md b/docs/invoice/UnauthorizedError.md index a988f3c3..92396b0b 100644 --- a/docs/invoice/UnauthorizedError.md +++ b/docs/invoice/UnauthorizedError.md @@ -1,11 +1,11 @@ # UnauthorizedError +An error object used to indicate unauthorized access to an invoice-related resource. ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | The specific error code associated with the unauthorized access. | | -| **Message** | **string** | A human-readable error message providing additional context about the unauthorized access. | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | The specific error code associated with the unauthorized access. | | +| **Message** | **string** | ☑️ | A human-readable error message providing additional context about the unauthorized access. | | ## Methods diff --git a/docs/payment_method.yaml b/docs/payment_method.yaml deleted file mode 100644 index a0f6c106..00000000 --- a/docs/payment_method.yaml +++ /dev/null @@ -1,2287 +0,0 @@ -openapi: 3.0.0 -info: - description: This API is used for Payment Method Service v2 - title: Payment Method Service v2 - version: 2.89.2 -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /v2/payment_methods: - get: - description: Get all payment methods by filters - operationId: getAllPaymentMethods - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: true - in: query - name: id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: type - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: status - required: false - schema: - items: - $ref: '#/components/schemas/PaymentMethodStatus' - type: array - style: form - - explode: true - in: query - name: reusability - required: false - schema: - $ref: '#/components/schemas/PaymentMethodReusability' - style: form - - explode: true - in: query - name: customer_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: reference_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: after_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: before_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: limit - required: false - schema: - minimum: 1 - type: integer - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethodList' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Get all payment methods by filters - tags: - - payment_method - post: - description: This endpoint initiates creation of payment method - operationId: createPaymentMethod - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - examples: - Account linking for E-Wallet: - value: - type: EWALLET - reusability: MULTIPLE_USE - customer: - reference_id: customer-123 - type: INDIVIDUAL - individual_detail: - given_names: John - surname: Doe - ewallet: - channel_code: OVO - channel_properties: - success_return_url: https://redirect.me/success - failure_return_url: https://redirect.me/failure - cancel_return_url: https://redirect.me/cancel - metadata: - sku: example-1234 - Account linking for PH Direct Debit: - value: - type: DIRECT_DEBIT - direct_debit: - channel_code: BPI - channel_properties: - success_return_url: https://redirect.me/success - failure_return_url: https://redirect.me/failure - reusability: MULTIPLE_USE - customer: - reference_id: customer-123 - type: INDIVIDUAL - individual_detail: - given_names: John - surname: Doe - email: testemail@email.com - mobile_number: 628774494404 - schema: - $ref: '#/components/schemas/PaymentMethodParameters' - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethod' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_409_response' - description: Request causes conflict - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Creates payment method - tags: - - payment_method - /v2/payment_methods/{paymentMethodId}: - get: - description: Get payment method by ID - operationId: getPaymentMethodByID - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethod' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Get payment method by ID - tags: - - payment_method - patch: - description: This endpoint is used to toggle the ```status``` of an e-Wallet - or a Direct Debit payment method to ```ACTIVE``` or ```INACTIVE```. This is - also used to update the details of an Over-the-Counter or a Virtual Account - payment method. - operationId: patchPaymentMethod - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethodUpdateParameters' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethod' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Patch payment methods - tags: - - payment_method - /v2/payment_methods/{paymentMethodId}/expire: - post: - description: This endpoint expires a payment method and performs unlinking if - necessary - operationId: expirePaymentMethod - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethodExpireParameters' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethod' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Expires a payment method - tags: - - payment_method - /v2/payment_methods/{paymentMethodId}/auth: - post: - description: This endpoint validates a payment method linking OTP - operationId: authPaymentMethod - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethodAuthParameters' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentMethod' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_409_response' - description: Request causes conflict - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Validate a payment method's linking OTP - tags: - - payment_method - /v2/payment_methods/{paymentMethodId}/payments: - get: - description: Returns payments with matching PaymentMethodID. - operationId: getPaymentsByPaymentMethodId - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: true - in: query - name: payment_request_id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: payment_method_id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: reference_id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: payment_method_type - required: false - schema: - items: - $ref: '#/components/schemas/PaymentMethodType' - type: array - style: form - - explode: true - in: query - name: channel_code - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: status - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: currency - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: "created[gte]" - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: "created[lte]" - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: "updated[gte]" - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: "updated[lte]" - required: false - schema: - $ref: '#/components/schemas/Datetime' - style: form - - explode: true - in: query - name: limit - required: false - schema: - type: integer - style: form - responses: - "200": - content: - application/json: - schema: - type: object - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Returns payments with matching PaymentMethodID. - tags: - - payment_method - /v2/payment_methods/{paymentMethodId}/payments/simulate: - post: - description: Makes payment with matching PaymentMethodID. - operationId: simulatePayment - parameters: - - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/simulatePayment_request' - responses: - "200": - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - summary: Makes payment with matching PaymentMethodID. - tags: - - payment_method -components: - parameters: - ForUserId: - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - PaymentMethodID: - explode: false - in: path - name: paymentMethodId - required: true - schema: - example: pm-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - responses: - InternalServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_default_response' - description: Internal server error - StatusBadRequest: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_400_response' - description: Bad request - StatusForbidden: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_403_response' - description: Forbidden due to permissions - StatusNotFound: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllPaymentMethods_404_response' - description: Data not found - StatusConflict: - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_409_response' - description: Request causes conflict - StatusServiceUnavailable: - content: - application/json: - schema: - $ref: '#/components/schemas/createPaymentMethod_503_response' - description: Service is unavailable due to dependencies - schemas: - PaymentMethodStatus: - enum: - - ACTIVE - - EXPIRED - - INACTIVE - - PENDING - - REQUIRES_ACTION - - FAILED - type: string - PaymentMethodReusability: - enum: - - MULTIPLE_USE - - ONE_TIME_USE - type: string - PaymentMethodType: - enum: - - CARD - - CRYPTOCURRENCY - - DIRECT_BANK_TRANSFER - - DIRECT_DEBIT - - EWALLET - - OVER_THE_COUNTER - - QR_CODE - - VIRTUAL_ACCOUNT - type: string - PaymentMethodCountry: - enum: - - PH - - ID - - VN - - TH - - MY - type: string - PaymentMethodAction: - example: - method: method - url_type: url_type - action: action - url: url - properties: - action: - type: string - method: - type: string - url: - type: string - url_type: - type: string - type: object - Object: - nullable: true - type: object - BillingInformation: - description: Billing Information - example: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - nullable: true - properties: - country: - maxLength: 2 - type: string - street_line1: - maxLength: 255 - nullable: true - type: string - street_line2: - maxLength: 255 - nullable: true - type: string - city: - maxLength: 255 - nullable: true - type: string - province_state: - maxLength: 255 - nullable: true - type: string - postal_code: - maxLength: 255 - nullable: true - type: string - required: - - country - type: object - Datetime: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - EWalletChannelCode: - description: EWallet Channel Code - enum: - - GCASH - - GRABPAY - - PAYMAYA - - OVO - - DANA - - LINKAJA - - SHOPEEPAY - - SAKUKU - - NEXCASH - - ASTRAPAY - - JENIUSPAY - - APPOTA - - MOMO - - VNPTWALLET - - VIETTELPAY - - ZALOPAY - - WECHATPAY - - LINEPAY - - TRUEMONEY - - ALIPAY - example: PAYMAYA - type: string - EWalletChannelProperties: - description: EWallet Channel Properties - example: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - nullable: false - properties: - success_return_url: - description: URL where the end-customer is redirected if the authorization - is successful - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - failure_return_url: - description: URL where the end-customer is redirected if the authorization - failed - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - cancel_return_url: - description: URL where the end-customer is redirected if the authorization - cancelled - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - mobile_number: - description: Mobile number of customer in E.164 format (e.g. +628123123123). - For OVO one time payment use only. - example: +628123123123 - type: string - redeem_points: - description: "REDEEM_NONE will not use any point, REDEEM_ALL will use all\ - \ available points before cash balance is used. For OVO and ShopeePay\ - \ tokenized payment use only." - example: REDEEM_NONE - type: string - cashtag: - description: Available for JENIUSPAY only - example: $abc1234 - pattern: "^[$][a-zA-Z0-9_]{3,15}$" - type: string - type: object - EWalletAccount: - description: EWallet Account Properties - example: - name: John Peter Doe - account_details: +63(2)123456XXXX - balance: null - point_balance: null - nullable: false - properties: - name: - description: Name of the eWallet account holder. The value is null if unavailableName - of the eWallet account holder. The value is null if unavailable - nullable: true - type: string - account_details: - description: Identifier from eWallet provider e.g. phone number. The value - is null if unavailable - nullable: true - type: string - balance: - description: The main balance amount on eWallet account provided from eWallet - provider. The value is null if unavailable - format: double - nullable: true - type: number - point_balance: - description: The point balance amount on eWallet account. Applicable only - on some eWallet provider that has point system. The value is null if unavailabl - format: double - nullable: true - type: number - type: object - EWalletParameters: - example: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - channel_code: PAYMAYA - account: - name: John Peter Doe - account_details: +63(2)123456XXXX - balance: null - point_balance: null - properties: - channel_code: - $ref: '#/components/schemas/EWalletChannelCode' - channel_properties: - $ref: '#/components/schemas/EWalletChannelProperties' - account: - $ref: '#/components/schemas/EWalletAccount' - required: - - channel_code - type: object - EWallet: - allOf: - - $ref: '#/components/schemas/EWalletParameters' - description: Ewallet Payment Method Details - nullable: true - type: object - DirectDebitChannelCode: - description: Direct Debit Channel Code - enum: - - BCA_KLIKPAY - - BCA_ONEKLIK - - BDO - - BPI - - BRI - - BNI - - CHINABANK - - CIMBNIAGA - - MTB - - RCBC - - UBP - - MANDIRI - - BBL - - SCB - - KTB - - BAY - - KBANK_MB - - BAY_MB - - KTB_MB - - BBL_MB - - SCB_MB - - BDO_EPAY - - AUTODEBIT_UBP - - AFFIN_FPX - - AGRO_FPX - - ALLIANCE_FPX - - AMBANK_FPX - - ISLAM_FPX - - MUAMALAT_FPX - - BOC_FPX - - RAKYAT_FPX - - BSN_FPX - - CIMB_FPX - - HLB_FPX - - HSBC_FPX - - KFH_FPX - - MAYB2E_FPX - - MAYB2U_FPX - - OCBC_FPX - - PUBLIC_FPX - - RHB_FPX - - SCH_FPX - - UOB_FPX - - AFFIN_FPX_BUSINESS - - AGRO_FPX_BUSINESS - - ALLIANCE_FPX_BUSINESS - - AMBANK_FPX_BUSINESS - - ISLAM_FPX_BUSINESS - - MUAMALAT_FPX_BUSINESS - - BNP_FPX_BUSINESS - - CIMB_FPX_BUSINESS - - CITIBANK_FPX_BUSINESS - - DEUTSCHE_FPX_BUSINESS - - HLB_FPX_BUSINESS - - HSBC_FPX_BUSINESS - - RAKYAT_FPX_BUSINESS - - KFH_FPX_BUSINESS - - MAYB2E_FPX_BUSINESS - - OCBC_FPX_BUSINESS - - PUBLIC_FPX_BUSINESS - - RHB_FPX_BUSINESS - - SCH_FPX_BUSINESS - - UOB_FPX_BUSINESS - example: BRI - type: string - DirectDebitChannelProperties: - description: Direct Debit Channel Properties - example: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - nullable: true - properties: - success_return_url: - format: uri - type: string - failure_return_url: - format: uri - nullable: true - type: string - mobile_number: - description: Mobile number of the customer registered to the partner channel - example: +62818555988 - nullable: true - type: string - card_last_four: - description: Last four digits of the debit card - example: "8888" - nullable: true - type: string - card_expiry: - description: Expiry month and year of the debit card (in MM/YY format) - example: 06/24 - nullable: true - type: string - email: - description: Email address of the customer that is registered to the partner - channel - example: test.email@xendit.co - nullable: true - type: string - identity_document_number: - description: Identity number of the customer registered to the partner channel - example: "1234567891113" - nullable: true - type: string - require_auth: - nullable: true - type: boolean - type: object - DirectDebitParameters: - example: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - channel_code: BRI - properties: - channel_code: - $ref: '#/components/schemas/DirectDebitChannelCode' - channel_properties: - $ref: '#/components/schemas/DirectDebitChannelProperties' - required: - - channel_code - - channel_properties - type: object - DirectDebitType: - enum: - - DEBIT_CARD - - BANK_ACCOUNT - - BANK_REDIRECT - type: string - DirectDebitBankAccount: - nullable: true - properties: - masked_bank_account_number: - example: 233eca40ff303ba15bf39052ca3102c6 - nullable: true - type: string - bank_account_hash: - example: 233eca40ff303ba15bf39052ca3102c6 - nullable: true - type: string - mobile_number: - description: Mobile number of the customer registered to the partner channel - example: +62818555988 - nullable: true - type: string - identity_document_number: - description: Identity number of the customer registered to the partner channel - example: "1234567891113" - nullable: true - type: string - type: object - DirectDebitDebitCard: - nullable: true - properties: - mobile_number: - description: Mobile number of the customer registered to the partner channel - example: +62818555988 - nullable: true - type: string - card_last_four: - description: Last four digits of the debit card - example: "8888" - nullable: true - type: string - card_expiry: - description: Expiry month and year of the debit card (in MM/YY format) - example: 06/24 - nullable: true - type: string - email: - description: Email address of the customer that is registered to the partner - channel - example: test.email@xendit.co - nullable: true - type: string - type: object - DirectDebit: - allOf: - - $ref: '#/components/schemas/DirectDebitParameters' - - $ref: '#/components/schemas/DirectDebit_allOf' - description: Direct Debit Payment Method Details - nullable: true - type: object - OverTheCounterChannelCode: - description: Over The Counter Channel Code - enum: - - 7ELEVEN - - 7ELEVEN_CLIQQ - - CEBUANA - - ECPAY - - PALAWAN - - MLHUILLIER - - ECPAY_DRAGONLOAN - - LBC - - ECPAY_SCHOOL - - RD_PAWNSHOP - - CVM - - USSC - - SM_BILLS - - ROBINSONS_BILLS - - ALFAMART - - INDOMARET - example: 7ELEVEN_CLIQQ - type: string - OverTheCounterChannelProperties: - description: Over The Counter Channel Properties - example: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - nullable: false - properties: - payment_code: - description: "The payment code that you want to assign, e.g 12345. If you\ - \ do not send one, one will be picked at random." - example: "12345" - type: string - customer_name: - description: Name of customer. - example: Rika Sutanto - type: string - expires_at: - description: The time when the payment code will be expired. The minimum - is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date - will be 2 days from payment code generated. - example: 2022-01-01T00:00:00Z - format: date-time - type: string - required: - - customer_name - type: object - OverTheCounterParameters: - example: - amount: 0.8008281904610115 - currency: currency - channel_properties: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - channel_code: 7ELEVEN_CLIQQ - properties: - amount: - format: double - nullable: true - type: number - currency: - type: string - channel_code: - $ref: '#/components/schemas/OverTheCounterChannelCode' - channel_properties: - $ref: '#/components/schemas/OverTheCounterChannelProperties' - required: - - channel_code - - channel_properties - type: object - OverTheCounter: - allOf: - - $ref: '#/components/schemas/OverTheCounterParameters' - description: Over The Counter Payment Method Details - nullable: true - type: object - CardChannelProperties: - description: Card Channel Properties - example: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - nullable: true - properties: - skip_three_d_secure: - description: This field value is only being used for reusability = MULTIPLE_USE. - To indicate whether to perform 3DS during the linking phase. Defaults - to false. - example: false - nullable: true - type: boolean - success_return_url: - description: URL where the end-customer is redirected if the authorization - is successful - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - nullable: true - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - failure_return_url: - description: URL where the end-customer is redirected if the authorization - failed - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - nullable: true - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - cardonfile_type: - description: Type of “credential-on-file” / “card-on-file” payment being - made. Indicate that this payment uses a previously linked Payment Method - for charging. - enum: - - MERCHANT_UNSCHEDULED - - CUSTOMER_UNSCHEDULED - - RECURRING - example: RECURRING - nullable: true - type: string - type: object - TokenizedCardInformation: - description: Tokenized Card Information - example: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: network - nullable: false - properties: - token_id: - type: string - masked_card_number: - description: 1st 6 and last 4 digits of the card - type: string - cardholder_name: - description: Cardholder name is optional but recommended for 3DS 2 / AVS - verification - nullable: true - type: string - expiry_month: - description: Card expiry month in MM format - type: string - expiry_year: - description: Card expiry month in YY format - type: string - fingerprint: - description: "Xendit-generated identifier for the unique card number. Multiple\ - \ payment method objects can be created for the same account - e.g. if\ - \ the user first creates a one-time payment request, and then later on\ - \ creates a multiple-use payment method using the same account. The\ - \ fingerprint helps to identify the unique account being used." - type: string - type: - description: Whether the card is a credit or debit card - type: string - network: - description: "Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA" - type: string - country: - description: Country where the card was issued ISO 3166-1 Alpha-2 - type: string - issuer: - description: "Issuer of the card, most often an issuing bank For example,\ - \ “BCA”, “MANDIRI”" - type: string - required: - - country - - expiry_month - - expiry_year - - fingerprint - - issuer - - masked_card_number - - network - - token_id - - type - type: object - CardVerificationResultsThreeDSecure: - example: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - three_d_secure_flow: - enum: - - CHALLENGE - - FRICTIONLESS - nullable: true - type: string - eci_code: - nullable: true - type: string - three_d_secure_result: - nullable: true - type: string - three_d_secure_result_reason: - nullable: true - type: string - three_d_secure_version: - nullable: true - type: string - type: object - CardVerificationResults: - example: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - three_d_secure: - $ref: '#/components/schemas/CardVerificationResultsThreeDSecure' - cvv_result: - nullable: true - type: string - address_verification_result: - nullable: true - type: string - required: - - three_d_secure - type: object - Card: - description: Card Payment Method Details - example: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: network - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - currency: - nullable: true - type: string - channel_properties: - $ref: '#/components/schemas/CardChannelProperties' - card_information: - $ref: '#/components/schemas/TokenizedCardInformation' - card_verification_results: - $ref: '#/components/schemas/CardVerificationResults' - required: - - channel_properties - - currency - type: object - QRCodeChannelCode: - description: QR Code Channel Code - enum: - - QRIS - - DANA - - RCBC - - PROMPTPAY - - LINKAJA - example: QRIS - nullable: true - type: string - QRCodeChannelProperties: - description: QR Code Channel Properties - example: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52 045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - nullable: true - properties: - qr_string: - description: "QR string to be rendered for display to end users. QR string\ - \ to image rendering are commonly available in software libraries (e.g\ - \ Nodejs, PHP, Java)" - example: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52 045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - type: string - expires_at: - example: 2022-01-01T00:00:00Z - format: date-time - type: string - type: object - QRCodeParameters: - example: - amount: 5.637376656633329 - currency: currency - channel_properties: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52 045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - channel_code: QRIS - properties: - amount: - format: double - nullable: true - type: number - currency: - type: string - channel_code: - $ref: '#/components/schemas/QRCodeChannelCode' - channel_properties: - $ref: '#/components/schemas/QRCodeChannelProperties' - type: object - QRCode: - allOf: - - $ref: '#/components/schemas/QRCodeParameters' - description: QR Code Payment Method Details - nullable: true - type: object - VirtualAccountChannelCode: - description: Virtual Account Channel Code - enum: - - BCA - - BJB - - BNI - - BRI - - MANDIRI - - PERMATA - - BSI - - CIMB - - SAHABAT_SAMPOERNA - - ARTAJASA - - PV - - VIETCAPITAL - - WOORI - - MSB - - STANDARD_CHARTERED - example: BCA - type: string - VirtualAccountChannelProperties: - description: Virtual Account Channel Properties - example: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - nullable: false - properties: - customer_name: - description: Name of customer. - example: Rika Sutanto - type: string - virtual_account_number: - description: "You can assign specific Virtual Account number using this\ - \ parameter. If you do not send one, one will be picked at random. Make\ - \ sure the number you specify is within your Virtual Account range." - example: "262159999999999" - type: string - expires_at: - description: "The date and time in ISO 8601 UTC+0 when the virtual account\ - \ number will be expired. Default: The default expiration date will be\ - \ 31 years from creation date." - example: 2022-01-01T00:00:00Z - format: date-time - type: string - suggested_amount: - description: "The suggested amount you want to assign. Note: Suggested amounts\ - \ is the amounts that can see as a suggestion, but user can still put\ - \ any numbers (only supported for Mandiri and BRI)" - example: 100000 - format: double - type: number - type: object - VirtualAccountParameters: - example: - amount: 6.027456183070403 - min_amount: 1.1465812980502945 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 1.5962133916683183 - currency: currency - channel_properties: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - channel_code: BCA - properties: - amount: - format: double - nullable: true - type: number - min_amount: - format: double - minimum: 1 - nullable: true - type: number - max_amount: - format: double - minimum: 1 - nullable: true - type: number - currency: - type: string - channel_code: - $ref: '#/components/schemas/VirtualAccountChannelCode' - channel_properties: - $ref: '#/components/schemas/VirtualAccountChannelProperties' - alternative_display_types: - description: "For payments in Vietnam only, alternative display requested\ - \ for the virtual account" - items: - enum: - - QR_STRING - type: string - type: array - required: - - channel_code - - channel_properties - type: object - VirtualAccountAlternativeDisplay: - description: Alternative Display Object - properties: - type: - description: Type of the alternative display - enum: - - QR_STRING - readOnly: true - type: string - data: - description: Data payload of the given alternative display - type: string - type: object - VirtualAccount: - allOf: - - $ref: '#/components/schemas/VirtualAccountParameters' - - $ref: '#/components/schemas/VirtualAccount_allOf' - description: Virtual Account Payment Method Details - nullable: true - type: object - PaymentMethod: - example: - billing_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - country: null - metadata: "{}" - failure_code: failure_code - reference_id: reference_id - created: 2016-08-29T09:12:33.001Z - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - customer_id: customer_id - business_id: business_id - actions: - - method: method - url_type: url_type - action: action - url: url - - method: method - url_type: url_type - action: action - url: url - updated: 2016-08-29T09:12:33.001Z - card: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: network - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - customer: "{}" - status: null - nullable: false - properties: - id: - type: string - business_id: - type: string - type: - $ref: '#/components/schemas/PaymentMethodType' - country: - $ref: '#/components/schemas/PaymentMethodCountry' - customer_id: - nullable: true - type: string - customer: - nullable: true - type: object - reference_id: - type: string - description: - nullable: true - type: string - status: - $ref: '#/components/schemas/PaymentMethodStatus' - reusability: - $ref: '#/components/schemas/PaymentMethodReusability' - actions: - items: - $ref: '#/components/schemas/PaymentMethodAction' - type: array - metadata: - nullable: true - type: object - billing_information: - $ref: '#/components/schemas/BillingInformation' - failure_code: - nullable: true - type: string - created: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - updated: - example: 2016-08-29T09:12:33.001Z - format: date-time - type: string - ewallet: - $ref: '#/components/schemas/EWallet' - direct_debit: - $ref: '#/components/schemas/DirectDebit' - over_the_counter: - $ref: '#/components/schemas/OverTheCounter' - card: - $ref: '#/components/schemas/Card' - qr_code: - $ref: '#/components/schemas/QRCode' - virtual_account: - $ref: '#/components/schemas/VirtualAccount' - required: - - id - type: object - PaymentMethodList: - example: - data: - - billing_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - country: null - metadata: "{}" - failure_code: failure_code - reference_id: reference_id - created: 2016-08-29T09:12:33.001Z - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - customer_id: customer_id - business_id: business_id - actions: - - method: method - url_type: url_type - action: action - url: url - - method: method - url_type: url_type - action: action - url: url - updated: 2016-08-29T09:12:33.001Z - card: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: network - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - customer: "{}" - status: null - - billing_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - country: null - metadata: "{}" - failure_code: failure_code - reference_id: reference_id - created: 2016-08-29T09:12:33.001Z - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - customer_id: customer_id - business_id: business_id - actions: - - method: method - url_type: url_type - action: action - url: url - - method: method - url_type: url_type - action: action - url: url - updated: 2016-08-29T09:12:33.001Z - card: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: network - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - customer: "{}" - status: null - has_more: true - nullable: false - properties: - data: - items: - $ref: '#/components/schemas/PaymentMethod' - type: array - has_more: - type: boolean - required: - - data - type: object - CardParameters: - example: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - cvv: cvv - card_number: card_number - cardholder_name: cardholder_name - expiry_year: expiry_year - properties: - currency: - type: string - channel_properties: - $ref: '#/components/schemas/CardChannelProperties' - card_information: - $ref: '#/components/schemas/CardParameters_card_information' - required: - - currency - type: object - PaymentMethodParameters: - example: - billing_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - country: country - metadata: "{}" - reference_id: reference_id - over_the_counter: - amount: 0.8008281904610115 - currency: currency - channel_properties: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - channel_code: 7ELEVEN_CLIQQ - reusability: null - description: description - type: null - direct_debit: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - channel_code: BRI - ewallet: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - channel_code: PAYMAYA - account: - name: John Peter Doe - account_details: +63(2)123456XXXX - balance: null - point_balance: null - virtual_account: - amount: 6.027456183070403 - min_amount: 1.1465812980502945 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 1.5962133916683183 - currency: currency - channel_properties: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - channel_code: BCA - qr_code: - amount: 5.637376656633329 - currency: currency - channel_properties: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52 045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - channel_code: QRIS - customer_id: customer_id - card: - currency: currency - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - cvv: cvv - card_number: card_number - cardholder_name: cardholder_name - expiry_year: expiry_year - nullable: false - properties: - type: - $ref: '#/components/schemas/PaymentMethodType' - country: - nullable: true - type: string - reusability: - $ref: '#/components/schemas/PaymentMethodReusability' - customer_id: - nullable: true - type: string - reference_id: - type: string - description: - nullable: true - type: string - card: - $ref: '#/components/schemas/CardParameters' - direct_debit: - $ref: '#/components/schemas/DirectDebitParameters' - ewallet: - $ref: '#/components/schemas/EWalletParameters' - over_the_counter: - $ref: '#/components/schemas/OverTheCounterParameters' - virtual_account: - $ref: '#/components/schemas/VirtualAccountParameters' - qr_code: - $ref: '#/components/schemas/QRCodeParameters' - metadata: - nullable: true - type: object - billing_information: - $ref: '#/components/schemas/BillingInformation' - required: - - reusability - - type - type: object - OverTheCounterChannelPropertiesUpdate: - description: Over The Counter Channel properties that can be updated - example: - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - nullable: false - properties: - customer_name: - description: Name of customer. - example: Rika Sutanto - type: string - expires_at: - description: The time when the payment code will be expired. The minimum - is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date - will be 2 days from payment code generated. - example: 2022-01-01T00:00:00Z - format: date-time - type: string - type: object - OverTheCounterUpdateParameters: - example: - amount: 0.8008281904610115 - channel_properties: - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - properties: - amount: - format: double - nullable: true - type: number - channel_properties: - $ref: '#/components/schemas/OverTheCounterChannelPropertiesUpdate' - type: object - VirtualAccountChannelPropertiesPatch: - description: Virtual Account Channel Properties - example: - expires_at: 2022-01-01T00:00:00Z - suggested_amount: 100000 - nullable: false - properties: - expires_at: - description: "The date and time in ISO 8601 UTC+0 when the virtual account\ - \ number will be expired. Default: The default expiration date will be\ - \ 31 years from creation date." - example: 2022-01-01T00:00:00Z - format: date-time - type: string - suggested_amount: - description: "The suggested amount you want to assign. Note: Suggested amounts\ - \ is the amounts that can see as a suggestion, but user can still put\ - \ any numbers (only supported for Mandiri and BRI)" - example: 100000 - format: double - minimum: 1 - type: number - type: object - VirtualAccountUpdateParameters: - example: - amount: 6.027456183070403 - min_amount: 1.1465812980502945 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 1.5962133916683183 - channel_properties: - expires_at: 2022-01-01T00:00:00Z - suggested_amount: 100000 - properties: - amount: - format: double - nullable: true - type: number - min_amount: - format: double - minimum: 1 - nullable: true - type: number - max_amount: - format: double - minimum: 1 - nullable: true - type: number - channel_properties: - $ref: '#/components/schemas/VirtualAccountChannelPropertiesPatch' - alternative_display_types: - description: "For payments in Vietnam only, alternative display requested\ - \ for the virtual account" - items: - enum: - - QR_STRING - type: string - type: array - type: object - PaymentMethodUpdateParameters: - example: - reference_id: reference_id - over_the_counter: - amount: 0.8008281904610115 - channel_properties: - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - virtual_account: - amount: 6.027456183070403 - min_amount: 1.1465812980502945 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 1.5962133916683183 - channel_properties: - expires_at: 2022-01-01T00:00:00Z - suggested_amount: 100000 - description: description - reusability: null - status: null - properties: - description: - type: string - reference_id: - type: string - reusability: - $ref: '#/components/schemas/PaymentMethodReusability' - status: - $ref: '#/components/schemas/PaymentMethodStatus' - over_the_counter: - $ref: '#/components/schemas/OverTheCounterUpdateParameters' - virtual_account: - $ref: '#/components/schemas/VirtualAccountUpdateParameters' - type: object - PaymentMethodExpireParameters: - example: - failure_return_url: failure_return_url - success_return_url: success_return_url - nullable: true - properties: - success_return_url: - description: URL where the end customer is redirected if the unlinking authorization - is successful. - nullable: true - type: string - failure_return_url: - description: URL where the end customer is redirected if the unlinking authorization - is failed. - nullable: true - type: string - type: object - PaymentMethodAuthParameters: - example: - auth_code: auth_code - nullable: false - properties: - auth_code: - maxLength: 6 - minLength: 6 - type: string - required: - - auth_code - type: object - getAllPaymentMethods_400_response: - properties: - error_code: - enum: - - API_VALIDATION_ERROR - - NOT_SUPPORTED_BY_CHANNEL - - EXPIRED_OTP_ERROR - - INVALID_ACCOUNT_DETAILS - - INVALID_OTP_ERROR - - INVALID_PAYMENT_METHOD - - MAX_OTP_ATTEMPTS_ERROR - - CUSTOMER_NOT_FOUND_ERROR - - ACCOUNT_ACCESS_BLOCKED - - MAX_ACCOUNT_LINKING - - INACTIVE_PAYMENT_METHOD - - PAYMENT_METHOD_NOT_SUPPORTED - - INCORRECT_AMOUNT - - DUPLICATED_FIXED_PAYMENT_INSTRUMENT - - CURRENCY_MISMATCHED - type: string - message: - example: An internal server error occurred - type: string - type: object - getAllPaymentMethods_403_response: - properties: - error_code: - enum: - - UNAUTHORIZED - - CHANNEL_NOT_ACTIVATED - type: string - message: - example: An internal server error occurred - type: string - type: object - getAllPaymentMethods_404_response: - properties: - error_code: - enum: - - DATA_NOT_FOUND - type: string - message: - example: An internal server error occurred - type: string - type: object - getAllPaymentMethods_default_response: - properties: - error_code: - type: string - message: - example: An internal server error occurred - type: string - type: object - createPaymentMethod_409_response: - properties: - error_code: - enum: - - PAYMENT_METHOD_ALREADY_ACTIVE - - PAYMENT_METHOD_ALREADY_FAILED - - DUPLICATE_ERROR - - IDEMPOTENCY_ERROR - type: string - message: - example: An internal server error occurred - type: string - type: object - createPaymentMethod_503_response: - properties: - error_code: - enum: - - CHANNEL_UNAVAILABLE - - OTP_DELIVERY_ERROR - type: string - message: - example: An internal server error occurred - type: string - type: object - simulatePayment_request: - properties: - amount: - format: double - nullable: false - type: number - type: object - DirectDebit_allOf: - properties: - type: - $ref: '#/components/schemas/DirectDebitType' - bank_account: - $ref: '#/components/schemas/DirectDebitBankAccount' - debit_card: - $ref: '#/components/schemas/DirectDebitDebitCard' - required: - - type - type: object - example: null - VirtualAccount_allOf: - properties: - alternative_displays: - items: - $ref: '#/components/schemas/VirtualAccountAlternativeDisplay' - type: array - type: object - example: null - CardParameters_card_information: - description: Card Information - example: - expiry_month: expiry_month - cvv: cvv - card_number: card_number - cardholder_name: cardholder_name - expiry_year: expiry_year - nullable: false - properties: - card_number: - type: string - expiry_month: - description: Card expiry month in MM format - type: string - expiry_year: - description: Card expiry month in YY format - type: string - cardholder_name: - description: Cardholder name - nullable: true - type: string - cvv: - nullable: true - type: string - required: - - card_number - - expiry_month - - expiry_year - type: object diff --git a/docs/payment_method/BillingInformation.md b/docs/payment_method/BillingInformation.md index 169d55a0..2d24061d 100644 --- a/docs/payment_method/BillingInformation.md +++ b/docs/payment_method/BillingInformation.md @@ -1,15 +1,15 @@ # BillingInformation +Billing Information ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Country** | **string** | | | -| **StreetLine1** | Pointer to **NullableString** | | [optional] | -| **StreetLine2** | Pointer to **NullableString** | | [optional] | -| **City** | Pointer to **NullableString** | | [optional] | -| **ProvinceState** | Pointer to **NullableString** | | [optional] | -| **PostalCode** | Pointer to **NullableString** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Country** | **string** | ☑️ | | | +| **StreetLine1** | Pointer to **NullableString** | | | | +| **StreetLine2** | Pointer to **NullableString** | | | | +| **City** | Pointer to **NullableString** | | | | +| **ProvinceState** | Pointer to **NullableString** | | | | +| **PostalCode** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_method/Card.md b/docs/payment_method/Card.md index d50d229f..3ffd2164 100644 --- a/docs/payment_method/Card.md +++ b/docs/payment_method/Card.md @@ -1,13 +1,13 @@ # Card +Card Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Currency** | **NullableString** | | | -| **ChannelProperties** | [**NullableCardChannelProperties**](CardChannelProperties.md) | | | -| **CardInformation** | Pointer to [**TokenizedCardInformation**](TokenizedCardInformation.md) | | [optional] | -| **CardVerificationResults** | Pointer to [**NullableCardVerificationResults**](CardVerificationResults.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Currency** | **NullableString** | ☑️ | | | +| **ChannelProperties** | [**NullableCardChannelProperties**](CardChannelProperties.md) | ☑️ | | | +| **CardInformation** | Pointer to [**TokenizedCardInformation**](TokenizedCardInformation.md) | | | | +| **CardVerificationResults** | Pointer to [**NullableCardVerificationResults**](CardVerificationResults.md) | | | | ## Methods diff --git a/docs/payment_method/CardChannelProperties.md b/docs/payment_method/CardChannelProperties.md index 14776e7d..4639f936 100644 --- a/docs/payment_method/CardChannelProperties.md +++ b/docs/payment_method/CardChannelProperties.md @@ -1,13 +1,13 @@ # CardChannelProperties +Card Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SkipThreeDSecure** | Pointer to **NullableBool** | This field value is only being used for reusability = MULTIPLE_USE. To indicate whether to perform 3DS during the linking phase. Defaults to false. | [optional] | -| **SuccessReturnUrl** | Pointer to **NullableString** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **NullableString** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CardonfileType** | Pointer to **NullableString** | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SkipThreeDSecure** | Pointer to **NullableBool** | | This field value is only being used for reusability = MULTIPLE_USE. To indicate whether to perform 3DS during the linking phase. Defaults to false. | | +| **SuccessReturnUrl** | Pointer to **NullableString** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **NullableString** | | URL where the end-customer is redirected if the authorization failed | | +| **CardonfileType** | Pointer to **NullableString** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | ## Methods diff --git a/docs/payment_method/CardParameters.md b/docs/payment_method/CardParameters.md index c7a642ef..35cb9f85 100644 --- a/docs/payment_method/CardParameters.md +++ b/docs/payment_method/CardParameters.md @@ -1,12 +1,12 @@ # CardParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Currency** | **string** | | | -| **ChannelProperties** | Pointer to [**NullableCardChannelProperties**](CardChannelProperties.md) | | [optional] | -| **CardInformation** | Pointer to [**CardParametersCardInformation**](CardParametersCardInformation.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Currency** | **string** | ☑️ | | | +| **ChannelProperties** | Pointer to [**NullableCardChannelProperties**](CardChannelProperties.md) | | | | +| **CardInformation** | Pointer to [**CardParametersCardInformation**](CardParametersCardInformation.md) | | | | ## Methods diff --git a/docs/payment_method/CardParametersCardInformation.md b/docs/payment_method/CardParametersCardInformation.md index ab49a39b..d7e1764f 100644 --- a/docs/payment_method/CardParametersCardInformation.md +++ b/docs/payment_method/CardParametersCardInformation.md @@ -1,14 +1,14 @@ # CardParametersCardInformation +Card Information ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **CardNumber** | **string** | | | -| **ExpiryMonth** | **string** | Card expiry month in MM format | | -| **ExpiryYear** | **string** | Card expiry month in YY format | | -| **CardholderName** | Pointer to **NullableString** | Cardholder name | [optional] | -| **Cvv** | Pointer to **NullableString** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **CardNumber** | **string** | ☑️ | | | +| **ExpiryMonth** | **string** | ☑️ | Card expiry month in MM format | | +| **ExpiryYear** | **string** | ☑️ | Card expiry month in YY format | | +| **CardholderName** | Pointer to **NullableString** | | Cardholder name | | +| **Cvv** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_method/CardVerificationResults.md b/docs/payment_method/CardVerificationResults.md index 9b9e9bfe..2c81f8ea 100644 --- a/docs/payment_method/CardVerificationResults.md +++ b/docs/payment_method/CardVerificationResults.md @@ -1,12 +1,12 @@ # CardVerificationResults -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecure** | [**NullableCardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | | -| **CvvResult** | Pointer to **NullableString** | | [optional] | -| **AddressVerificationResult** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecure** | [**NullableCardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | ☑️ | | | +| **CvvResult** | Pointer to **NullableString** | | | | +| **AddressVerificationResult** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_method/CardVerificationResultsThreeDSecure.md b/docs/payment_method/CardVerificationResultsThreeDSecure.md index bbdbeacb..decf50da 100644 --- a/docs/payment_method/CardVerificationResultsThreeDSecure.md +++ b/docs/payment_method/CardVerificationResultsThreeDSecure.md @@ -1,14 +1,14 @@ # CardVerificationResultsThreeDSecure -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecureFlow** | Pointer to **NullableString** | | [optional] | -| **EciCode** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureResult** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureResultReason** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureVersion** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecureFlow** | Pointer to **NullableString** | | | | +| **EciCode** | Pointer to **NullableString** | | | | +| **ThreeDSecureResult** | Pointer to **NullableString** | | | | +| **ThreeDSecureResultReason** | Pointer to **NullableString** | | | | +| **ThreeDSecureVersion** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_method/CreatePaymentMethod409Response.md b/docs/payment_method/CreatePaymentMethod409Response.md index 815580b8..fd55bba9 100644 --- a/docs/payment_method/CreatePaymentMethod409Response.md +++ b/docs/payment_method/CreatePaymentMethod409Response.md @@ -1,11 +1,11 @@ # CreatePaymentMethod409Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/CreatePaymentMethod503Response.md b/docs/payment_method/CreatePaymentMethod503Response.md index a7613651..8e6bf21b 100644 --- a/docs/payment_method/CreatePaymentMethod503Response.md +++ b/docs/payment_method/CreatePaymentMethod503Response.md @@ -1,11 +1,11 @@ # CreatePaymentMethod503Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/DirectDebit.md b/docs/payment_method/DirectDebit.md index bac4f451..b1e73860 100644 --- a/docs/payment_method/DirectDebit.md +++ b/docs/payment_method/DirectDebit.md @@ -1,14 +1,14 @@ # DirectDebit +Direct Debit Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | -| **Type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | +| **Type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | +| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | ## Methods diff --git a/docs/payment_method/DirectDebitAllOf.md b/docs/payment_method/DirectDebitAllOf.md index a3f8b08e..08719b9c 100644 --- a/docs/payment_method/DirectDebitAllOf.md +++ b/docs/payment_method/DirectDebitAllOf.md @@ -1,12 +1,12 @@ # DirectDebitAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | +| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | ## Methods diff --git a/docs/payment_method/DirectDebitBankAccount.md b/docs/payment_method/DirectDebitBankAccount.md index 5b439e73..e5266783 100644 --- a/docs/payment_method/DirectDebitBankAccount.md +++ b/docs/payment_method/DirectDebitBankAccount.md @@ -1,13 +1,13 @@ # DirectDebitBankAccount -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MaskedBankAccountNumber** | Pointer to **NullableString** | | [optional] | -| **BankAccountHash** | Pointer to **NullableString** | | [optional] | -| **MobileNumber** | Pointer to **NullableString** | Mobile number of the customer registered to the partner channel | [optional] | -| **IdentityDocumentNumber** | Pointer to **NullableString** | Identity number of the customer registered to the partner channel | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MaskedBankAccountNumber** | Pointer to **NullableString** | | | | +| **BankAccountHash** | Pointer to **NullableString** | | | | +| **MobileNumber** | Pointer to **NullableString** | | Mobile number of the customer registered to the partner channel | | +| **IdentityDocumentNumber** | Pointer to **NullableString** | | Identity number of the customer registered to the partner channel | | ## Methods diff --git a/docs/payment_method/DirectDebitChannelCode.md b/docs/payment_method/DirectDebitChannelCode.md index 259da477..0f17d6e5 100644 --- a/docs/payment_method/DirectDebitChannelCode.md +++ b/docs/payment_method/DirectDebitChannelCode.md @@ -1,135 +1,135 @@ # DirectDebitChannelCode - -## Enum - - -* `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) - -* `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) - -* `BDO` (value: `"BDO"`) - -* `BPI` (value: `"BPI"`) - -* `BRI` (value: `"BRI"`) - -* `BNI` (value: `"BNI"`) - -* `CHINABANK` (value: `"CHINABANK"`) - -* `CIMBNIAGA` (value: `"CIMBNIAGA"`) - -* `MTB` (value: `"MTB"`) - -* `RCBC` (value: `"RCBC"`) - -* `UBP` (value: `"UBP"`) - -* `MANDIRI` (value: `"MANDIRI"`) - -* `BBL` (value: `"BBL"`) - -* `SCB` (value: `"SCB"`) - -* `KTB` (value: `"KTB"`) - -* `BAY` (value: `"BAY"`) - -* `KBANK_MB` (value: `"KBANK_MB"`) - -* `BAY_MB` (value: `"BAY_MB"`) - -* `KTB_MB` (value: `"KTB_MB"`) - -* `BBL_MB` (value: `"BBL_MB"`) - -* `SCB_MB` (value: `"SCB_MB"`) - -* `BDO_EPAY` (value: `"BDO_EPAY"`) - -* `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) - -* `AFFIN_FPX` (value: `"AFFIN_FPX"`) - -* `AGRO_FPX` (value: `"AGRO_FPX"`) - -* `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) - -* `AMBANK_FPX` (value: `"AMBANK_FPX"`) - -* `ISLAM_FPX` (value: `"ISLAM_FPX"`) - -* `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) - -* `BOC_FPX` (value: `"BOC_FPX"`) - -* `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) - -* `BSN_FPX` (value: `"BSN_FPX"`) - -* `CIMB_FPX` (value: `"CIMB_FPX"`) - -* `HLB_FPX` (value: `"HLB_FPX"`) - -* `HSBC_FPX` (value: `"HSBC_FPX"`) - -* `KFH_FPX` (value: `"KFH_FPX"`) - -* `MAYB2_E_FPX` (value: `"MAYB2E_FPX"`) - -* `MAYB2_U_FPX` (value: `"MAYB2U_FPX"`) - -* `OCBC_FPX` (value: `"OCBC_FPX"`) - -* `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) - -* `RHB_FPX` (value: `"RHB_FPX"`) - -* `SCH_FPX` (value: `"SCH_FPX"`) - -* `UOB_FPX` (value: `"UOB_FPX"`) - -* `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) - -* `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) - -* `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) - -* `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) - -* `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) - -* `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) - -* `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) - -* `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) - -* `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) - -* `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) - -* `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) - -* `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) - -* `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) - -* `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) - -* `MAYB2_E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) - -* `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) - -* `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) - -* `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) - -* `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) - -* `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Direct Debit Channel Code + + ## Enum + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) + + * `BDO` (value: `"BDO"`) + + * `BPI` (value: `"BPI"`) + + * `BRI` (value: `"BRI"`) + + * `BNI` (value: `"BNI"`) + + * `CHINABANK` (value: `"CHINABANK"`) + + * `CIMBNIAGA` (value: `"CIMBNIAGA"`) + + * `MTB` (value: `"MTB"`) + + * `RCBC` (value: `"RCBC"`) + + * `UBP` (value: `"UBP"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `BBL` (value: `"BBL"`) + + * `SCB` (value: `"SCB"`) + + * `KTB` (value: `"KTB"`) + + * `BAY` (value: `"BAY"`) + + * `KBANK_MB` (value: `"KBANK_MB"`) + + * `BAY_MB` (value: `"BAY_MB"`) + + * `KTB_MB` (value: `"KTB_MB"`) + + * `BBL_MB` (value: `"BBL_MB"`) + + * `SCB_MB` (value: `"SCB_MB"`) + + * `BDO_EPAY` (value: `"BDO_EPAY"`) + + * `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) + + * `AFFIN_FPX` (value: `"AFFIN_FPX"`) + + * `AGRO_FPX` (value: `"AGRO_FPX"`) + + * `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) + + * `AMBANK_FPX` (value: `"AMBANK_FPX"`) + + * `ISLAM_FPX` (value: `"ISLAM_FPX"`) + + * `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) + + * `BOC_FPX` (value: `"BOC_FPX"`) + + * `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) + + * `BSN_FPX` (value: `"BSN_FPX"`) + + * `CIMB_FPX` (value: `"CIMB_FPX"`) + + * `HLB_FPX` (value: `"HLB_FPX"`) + + * `HSBC_FPX` (value: `"HSBC_FPX"`) + + * `KFH_FPX` (value: `"KFH_FPX"`) + + * `MAYB2_E_FPX` (value: `"MAYB2E_FPX"`) + + * `MAYB2_U_FPX` (value: `"MAYB2U_FPX"`) + + * `OCBC_FPX` (value: `"OCBC_FPX"`) + + * `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) + + * `RHB_FPX` (value: `"RHB_FPX"`) + + * `SCH_FPX` (value: `"SCH_FPX"`) + + * `UOB_FPX` (value: `"UOB_FPX"`) + + * `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) + + * `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) + + * `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) + + * `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) + + * `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) + + * `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) + + * `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) + + * `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) + + * `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) + + * `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) + + * `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) + + * `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) + + * `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) + + * `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) + + * `MAYB2_E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) + + * `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) + + * `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) + + * `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) + + * `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) + + * `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/DirectDebitChannelProperties.md b/docs/payment_method/DirectDebitChannelProperties.md index 092f0953..823e571a 100644 --- a/docs/payment_method/DirectDebitChannelProperties.md +++ b/docs/payment_method/DirectDebitChannelProperties.md @@ -1,17 +1,18 @@ # DirectDebitChannelProperties +Direct Debit Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | | [optional] | -| **FailureReturnUrl** | Pointer to **NullableString** | | [optional] | -| **MobileNumber** | Pointer to **NullableString** | Mobile number of the customer registered to the partner channel | [optional] | -| **CardLastFour** | Pointer to **NullableString** | Last four digits of the debit card | [optional] | -| **CardExpiry** | Pointer to **NullableString** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **Email** | Pointer to **NullableString** | Email address of the customer that is registered to the partner channel | [optional] | -| **IdentityDocumentNumber** | Pointer to **NullableString** | Identity number of the customer registered to the partner channel | [optional] | -| **RequireAuth** | Pointer to **NullableBool** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | | | +| **FailureReturnUrl** | Pointer to **NullableString** | | | | +| **MobileNumber** | Pointer to **NullableString** | | Mobile number of the customer registered to the partner channel | | +| **CardLastFour** | Pointer to **NullableString** | | Last four digits of the debit card | | +| **CardExpiry** | Pointer to **NullableString** | | Expiry month and year of the debit card (in MM/YY format) | | +| **Email** | Pointer to **NullableString** | | Email address of the customer that is registered to the partner channel | | +| **IdentityDocumentNumber** | Pointer to **NullableString** | | Identity number of the customer registered to the partner channel | | +| **RequireAuth** | Pointer to **NullableBool** | | | | +| **AccountNumber** | Pointer to **NullableString** | | Account number of the customer | | ## Methods @@ -302,6 +303,41 @@ HasRequireAuth returns a boolean if a field has been set. `func (o *DirectDebitChannelProperties) UnsetRequireAuth()` UnsetRequireAuth ensures that no value is present for RequireAuth, not even an explicit nil +### GetAccountNumber + +`func (o *DirectDebitChannelProperties) GetAccountNumber() string` + +GetAccountNumber returns the AccountNumber field if non-nil, zero value otherwise. + +### GetAccountNumberOk + +`func (o *DirectDebitChannelProperties) GetAccountNumberOk() (*string, bool)` + +GetAccountNumberOk returns a tuple with the AccountNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNumber + +`func (o *DirectDebitChannelProperties) SetAccountNumber(v string)` + +SetAccountNumber sets AccountNumber field to given value. + +### HasAccountNumber + +`func (o *DirectDebitChannelProperties) HasAccountNumber() bool` + +HasAccountNumber returns a boolean if a field has been set. + +### SetAccountNumberNil + +`func (o *DirectDebitChannelProperties) SetAccountNumberNil(b bool)` + + SetAccountNumberNil sets the value for AccountNumber to be an explicit nil + +### UnsetAccountNumber +`func (o *DirectDebitChannelProperties) UnsetAccountNumber()` + +UnsetAccountNumber ensures that no value is present for AccountNumber, not even an explicit nil [[Back to README]](../../README.md) diff --git a/docs/payment_method/DirectDebitDebitCard.md b/docs/payment_method/DirectDebitDebitCard.md index 550522e8..e726882a 100644 --- a/docs/payment_method/DirectDebitDebitCard.md +++ b/docs/payment_method/DirectDebitDebitCard.md @@ -1,13 +1,14 @@ # DirectDebitDebitCard -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MobileNumber** | Pointer to **NullableString** | Mobile number of the customer registered to the partner channel | [optional] | -| **CardLastFour** | Pointer to **NullableString** | Last four digits of the debit card | [optional] | -| **CardExpiry** | Pointer to **NullableString** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **Email** | Pointer to **NullableString** | Email address of the customer that is registered to the partner channel | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MobileNumber** | Pointer to **NullableString** | | Mobile number of the customer registered to the partner channel | | +| **CardLastFour** | Pointer to **NullableString** | | Last four digits of the debit card | | +| **CardExpiry** | Pointer to **NullableString** | | Expiry month and year of the debit card (in MM/YY format) | | +| **Email** | Pointer to **NullableString** | | Email address of the customer that is registered to the partner channel | | +| **AccountNumber** | Pointer to **NullableString** | | Account number of the customer | | ## Methods @@ -168,6 +169,41 @@ HasEmail returns a boolean if a field has been set. `func (o *DirectDebitDebitCard) UnsetEmail()` UnsetEmail ensures that no value is present for Email, not even an explicit nil +### GetAccountNumber + +`func (o *DirectDebitDebitCard) GetAccountNumber() string` + +GetAccountNumber returns the AccountNumber field if non-nil, zero value otherwise. + +### GetAccountNumberOk + +`func (o *DirectDebitDebitCard) GetAccountNumberOk() (*string, bool)` + +GetAccountNumberOk returns a tuple with the AccountNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAccountNumber + +`func (o *DirectDebitDebitCard) SetAccountNumber(v string)` + +SetAccountNumber sets AccountNumber field to given value. + +### HasAccountNumber + +`func (o *DirectDebitDebitCard) HasAccountNumber() bool` + +HasAccountNumber returns a boolean if a field has been set. + +### SetAccountNumberNil + +`func (o *DirectDebitDebitCard) SetAccountNumberNil(b bool)` + + SetAccountNumberNil sets the value for AccountNumber to be an explicit nil + +### UnsetAccountNumber +`func (o *DirectDebitDebitCard) UnsetAccountNumber()` + +UnsetAccountNumber ensures that no value is present for AccountNumber, not even an explicit nil [[Back to README]](../../README.md) diff --git a/docs/payment_method/DirectDebitParameters.md b/docs/payment_method/DirectDebitParameters.md index 245be890..cdaa3d1f 100644 --- a/docs/payment_method/DirectDebitParameters.md +++ b/docs/payment_method/DirectDebitParameters.md @@ -1,11 +1,11 @@ # DirectDebitParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | ## Methods diff --git a/docs/payment_method/DirectDebitType.md b/docs/payment_method/DirectDebitType.md index 71b174c0..4dae3ad5 100644 --- a/docs/payment_method/DirectDebitType.md +++ b/docs/payment_method/DirectDebitType.md @@ -1,15 +1,15 @@ # DirectDebitType -## Enum - -* `DEBIT_CARD` (value: `"DEBIT_CARD"`) - -* `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) - -* `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `DEBIT_CARD` (value: `"DEBIT_CARD"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/EWallet.md b/docs/payment_method/EWallet.md index 2d3adae2..a66fa083 100644 --- a/docs/payment_method/EWallet.md +++ b/docs/payment_method/EWallet.md @@ -1,12 +1,12 @@ # EWallet +Ewallet Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | -| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | -| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | +| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | | | ## Methods diff --git a/docs/payment_method/EWalletAccount.md b/docs/payment_method/EWalletAccount.md index 445abbb5..d51f2850 100644 --- a/docs/payment_method/EWalletAccount.md +++ b/docs/payment_method/EWalletAccount.md @@ -1,13 +1,13 @@ # EWalletAccount +EWallet Account Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Name** | Pointer to **NullableString** | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | [optional] | -| **AccountDetails** | Pointer to **NullableString** | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | [optional] | -| **Balance** | Pointer to **NullableFloat64** | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | [optional] | -| **PointBalance** | Pointer to **NullableFloat64** | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Name** | Pointer to **NullableString** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | | +| **AccountDetails** | Pointer to **NullableString** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | +| **Balance** | Pointer to **NullableFloat64** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | +| **PointBalance** | Pointer to **NullableFloat64** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | | ## Methods diff --git a/docs/payment_method/EWalletChannelCode.md b/docs/payment_method/EWalletChannelCode.md index 6ef2d22f..236f90fe 100644 --- a/docs/payment_method/EWalletChannelCode.md +++ b/docs/payment_method/EWalletChannelCode.md @@ -1,49 +1,51 @@ # EWalletChannelCode - -## Enum - - -* `GCASH` (value: `"GCASH"`) - -* `GRABPAY` (value: `"GRABPAY"`) - -* `PAYMAYA` (value: `"PAYMAYA"`) - -* `OVO` (value: `"OVO"`) - -* `DANA` (value: `"DANA"`) - -* `LINKAJA` (value: `"LINKAJA"`) - -* `SHOPEEPAY` (value: `"SHOPEEPAY"`) - -* `SAKUKU` (value: `"SAKUKU"`) - -* `NEXCASH` (value: `"NEXCASH"`) - -* `ASTRAPAY` (value: `"ASTRAPAY"`) - -* `JENIUSPAY` (value: `"JENIUSPAY"`) - -* `APPOTA` (value: `"APPOTA"`) - -* `MOMO` (value: `"MOMO"`) - -* `VNPTWALLET` (value: `"VNPTWALLET"`) - -* `VIETTELPAY` (value: `"VIETTELPAY"`) - -* `ZALOPAY` (value: `"ZALOPAY"`) - -* `WECHATPAY` (value: `"WECHATPAY"`) - -* `LINEPAY` (value: `"LINEPAY"`) - -* `TRUEMONEY` (value: `"TRUEMONEY"`) - -* `ALIPAY` (value: `"ALIPAY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +EWallet Channel Code + + ## Enum + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `OVO` (value: `"OVO"`) + + * `DANA` (value: `"DANA"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `SAKUKU` (value: `"SAKUKU"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `APPOTA` (value: `"APPOTA"`) + + * `MOMO` (value: `"MOMO"`) + + * `VNPTWALLET` (value: `"VNPTWALLET"`) + + * `VIETTELPAY` (value: `"VIETTELPAY"`) + + * `ZALOPAY` (value: `"ZALOPAY"`) + + * `WECHATPAY` (value: `"WECHATPAY"`) + + * `LINEPAY` (value: `"LINEPAY"`) + + * `TRUEMONEY` (value: `"TRUEMONEY"`) + + * `ALIPAY` (value: `"ALIPAY"`) + + * `TOUCHANDGO` (value: `"TOUCHANDGO"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/EWalletChannelProperties.md b/docs/payment_method/EWalletChannelProperties.md index 34a1c9cc..dde86449 100644 --- a/docs/payment_method/EWalletChannelProperties.md +++ b/docs/payment_method/EWalletChannelProperties.md @@ -1,15 +1,15 @@ # EWalletChannelProperties +EWallet Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CancelReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **MobileNumber** | Pointer to **string** | Mobile number of customer in E.164 format (e.g. +628123123123). For OVO one time payment use only. | [optional] | -| **RedeemPoints** | Pointer to **string** | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | [optional] | -| **Cashtag** | Pointer to **string** | Available for JENIUSPAY only | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization failed | | +| **CancelReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization cancelled | | +| **MobileNumber** | Pointer to **string** | | Mobile number of customer in E.164 format (e.g. +628123123123). For OVO one time payment use only. | | +| **RedeemPoints** | Pointer to **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | +| **Cashtag** | Pointer to **string** | | Available for JENIUSPAY only | | ## Methods diff --git a/docs/payment_method/EWalletParameters.md b/docs/payment_method/EWalletParameters.md index 7bddbc71..7e229750 100644 --- a/docs/payment_method/EWalletParameters.md +++ b/docs/payment_method/EWalletParameters.md @@ -1,12 +1,12 @@ # EWalletParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**EWalletChannelCode**](EWalletChannelCode.md) | | | -| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | -| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**EWalletChannelCode**](EWalletChannelCode.md) | ☑️ | | | +| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | | | ## Methods diff --git a/docs/payment_method/GetAllPaymentMethods400Response.md b/docs/payment_method/GetAllPaymentMethods400Response.md index 93ee6fc9..e63befbe 100644 --- a/docs/payment_method/GetAllPaymentMethods400Response.md +++ b/docs/payment_method/GetAllPaymentMethods400Response.md @@ -1,11 +1,11 @@ # GetAllPaymentMethods400Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/GetAllPaymentMethods403Response.md b/docs/payment_method/GetAllPaymentMethods403Response.md index bd3cbcc9..38eecb18 100644 --- a/docs/payment_method/GetAllPaymentMethods403Response.md +++ b/docs/payment_method/GetAllPaymentMethods403Response.md @@ -1,11 +1,11 @@ # GetAllPaymentMethods403Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/GetAllPaymentMethods404Response.md b/docs/payment_method/GetAllPaymentMethods404Response.md index 0bd0a022..22bd4de0 100644 --- a/docs/payment_method/GetAllPaymentMethods404Response.md +++ b/docs/payment_method/GetAllPaymentMethods404Response.md @@ -1,11 +1,11 @@ # GetAllPaymentMethods404Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md b/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md index de1936bd..06a6494e 100644 --- a/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md +++ b/docs/payment_method/GetAllPaymentMethodsDefaultResponse.md @@ -1,11 +1,11 @@ # GetAllPaymentMethodsDefaultResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/OverTheCounter.md b/docs/payment_method/OverTheCounter.md index 20cb98cc..3a38eaa5 100644 --- a/docs/payment_method/OverTheCounter.md +++ b/docs/payment_method/OverTheCounter.md @@ -1,13 +1,13 @@ # OverTheCounter +Over The Counter Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | ## Methods diff --git a/docs/payment_method/OverTheCounterChannelCode.md b/docs/payment_method/OverTheCounterChannelCode.md index d581279d..13a38af3 100644 --- a/docs/payment_method/OverTheCounterChannelCode.md +++ b/docs/payment_method/OverTheCounterChannelCode.md @@ -1,41 +1,41 @@ # OverTheCounterChannelCode - -## Enum - - -* `_7_ELEVEN` (value: `"7ELEVEN"`) - -* `_7_ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) - -* `CEBUANA` (value: `"CEBUANA"`) - -* `ECPAY` (value: `"ECPAY"`) - -* `PALAWAN` (value: `"PALAWAN"`) - -* `MLHUILLIER` (value: `"MLHUILLIER"`) - -* `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) - -* `LBC` (value: `"LBC"`) - -* `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) - -* `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) - -* `CVM` (value: `"CVM"`) - -* `USSC` (value: `"USSC"`) - -* `SM_BILLS` (value: `"SM_BILLS"`) - -* `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) - -* `ALFAMART` (value: `"ALFAMART"`) - -* `INDOMARET` (value: `"INDOMARET"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Over The Counter Channel Code + + ## Enum + + * `_7_ELEVEN` (value: `"7ELEVEN"`) + + * `_7_ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `ECPAY` (value: `"ECPAY"`) + + * `PALAWAN` (value: `"PALAWAN"`) + + * `MLHUILLIER` (value: `"MLHUILLIER"`) + + * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) + + * `LBC` (value: `"LBC"`) + + * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) + + * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) + + * `CVM` (value: `"CVM"`) + + * `USSC` (value: `"USSC"`) + + * `SM_BILLS` (value: `"SM_BILLS"`) + + * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/OverTheCounterChannelProperties.md b/docs/payment_method/OverTheCounterChannelProperties.md index 5454d548..00d383b4 100644 --- a/docs/payment_method/OverTheCounterChannelProperties.md +++ b/docs/payment_method/OverTheCounterChannelProperties.md @@ -1,12 +1,12 @@ # OverTheCounterChannelProperties +Over The Counter Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **PaymentCode** | Pointer to **string** | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | [optional] | -| **CustomerName** | **string** | Name of customer. | | -| **ExpiresAt** | Pointer to **time.Time** | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **PaymentCode** | Pointer to **string** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | | +| **CustomerName** | **string** | ☑️ | Name of customer. | | +| **ExpiresAt** | Pointer to **time.Time** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | ## Methods diff --git a/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md b/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md index 946ab2e2..c28a2c6a 100644 --- a/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md +++ b/docs/payment_method/OverTheCounterChannelPropertiesUpdate.md @@ -1,11 +1,11 @@ # OverTheCounterChannelPropertiesUpdate +Over The Counter Channel properties that can be updated ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **CustomerName** | Pointer to **string** | Name of customer. | [optional] | -| **ExpiresAt** | Pointer to **time.Time** | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **CustomerName** | Pointer to **string** | | Name of customer. | | +| **ExpiresAt** | Pointer to **time.Time** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | ## Methods diff --git a/docs/payment_method/OverTheCounterParameters.md b/docs/payment_method/OverTheCounterParameters.md index 5d68b8d2..3cb2b65c 100644 --- a/docs/payment_method/OverTheCounterParameters.md +++ b/docs/payment_method/OverTheCounterParameters.md @@ -1,13 +1,13 @@ # OverTheCounterParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | ## Methods diff --git a/docs/payment_method/OverTheCounterUpdateParameters.md b/docs/payment_method/OverTheCounterUpdateParameters.md index 9110e40d..7824a159 100644 --- a/docs/payment_method/OverTheCounterUpdateParameters.md +++ b/docs/payment_method/OverTheCounterUpdateParameters.md @@ -1,11 +1,11 @@ # OverTheCounterUpdateParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **ChannelProperties** | Pointer to [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **ChannelProperties** | Pointer to [**OverTheCounterChannelPropertiesUpdate**](OverTheCounterChannelPropertiesUpdate.md) | | | | ## Methods diff --git a/docs/payment_method/PaymentMethod.md b/docs/payment_method/PaymentMethod.md index 5ee7976a..6d80b6c9 100644 --- a/docs/payment_method/PaymentMethod.md +++ b/docs/payment_method/PaymentMethod.md @@ -1,31 +1,31 @@ # PaymentMethod -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | | | -| **BusinessId** | Pointer to **string** | | [optional] | -| **Type** | Pointer to [**PaymentMethodType**](PaymentMethodType.md) | | [optional] | -| **Country** | Pointer to [**PaymentMethodCountry**](PaymentMethodCountry.md) | | [optional] | -| **CustomerId** | Pointer to **NullableString** | | [optional] | -| **Customer** | Pointer to **map[string]interface{}** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **Status** | Pointer to [**PaymentMethodStatus**](PaymentMethodStatus.md) | | [optional] | -| **Reusability** | Pointer to [**PaymentMethodReusability**](PaymentMethodReusability.md) | | [optional] | -| **Actions** | Pointer to [**PaymentMethodAction[]**](PaymentMethodAction.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | -| **BillingInformation** | Pointer to [**NullableBillingInformation**](BillingInformation.md) | | [optional] | -| **FailureCode** | Pointer to **NullableString** | | [optional] | -| **Created** | Pointer to **time.Time** | | [optional] | -| **Updated** | Pointer to **time.Time** | | [optional] | -| **Ewallet** | Pointer to [**NullableEWallet**](EWallet.md) | | [optional] | -| **DirectDebit** | Pointer to [**NullableDirectDebit**](DirectDebit.md) | | [optional] | -| **OverTheCounter** | Pointer to [**NullableOverTheCounter**](OverTheCounter.md) | | [optional] | -| **Card** | Pointer to [**NullableCard**](Card.md) | | [optional] | -| **QrCode** | Pointer to [**NullableQRCode**](QRCode.md) | | [optional] | -| **VirtualAccount** | Pointer to [**NullableVirtualAccount**](VirtualAccount.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | | | +| **BusinessId** | Pointer to **string** | | | | +| **Type** | Pointer to [**PaymentMethodType**](PaymentMethodType.md) | | | | +| **Country** | Pointer to [**PaymentMethodCountry**](PaymentMethodCountry.md) | | | | +| **CustomerId** | Pointer to **NullableString** | | | | +| **Customer** | Pointer to **map[string]interface{}** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **Description** | Pointer to **NullableString** | | | | +| **Status** | Pointer to [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | +| **Reusability** | Pointer to [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | +| **Actions** | Pointer to [**PaymentMethodAction[]**](PaymentMethodAction.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | +| **BillingInformation** | Pointer to [**NullableBillingInformation**](BillingInformation.md) | | | | +| **FailureCode** | Pointer to **NullableString** | | | | +| **Created** | Pointer to **time.Time** | | | | +| **Updated** | Pointer to **time.Time** | | | | +| **Ewallet** | Pointer to [**NullableEWallet**](EWallet.md) | | | | +| **DirectDebit** | Pointer to [**NullableDirectDebit**](DirectDebit.md) | | | | +| **OverTheCounter** | Pointer to [**NullableOverTheCounter**](OverTheCounter.md) | | | | +| **Card** | Pointer to [**NullableCard**](Card.md) | | | | +| **QrCode** | Pointer to [**NullableQRCode**](QRCode.md) | | | | +| **VirtualAccount** | Pointer to [**NullableVirtualAccount**](VirtualAccount.md) | | | | ## Methods diff --git a/docs/payment_method/PaymentMethodAction.md b/docs/payment_method/PaymentMethodAction.md index 36a22386..65189c6b 100644 --- a/docs/payment_method/PaymentMethodAction.md +++ b/docs/payment_method/PaymentMethodAction.md @@ -1,13 +1,13 @@ # PaymentMethodAction -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Action** | Pointer to **string** | | [optional] | -| **Method** | Pointer to **string** | | [optional] | -| **Url** | Pointer to **string** | | [optional] | -| **UrlType** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Action** | Pointer to **string** | | | | +| **Method** | Pointer to **string** | | | | +| **Url** | Pointer to **string** | | | | +| **UrlType** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_method/PaymentMethodAuthParameters.md b/docs/payment_method/PaymentMethodAuthParameters.md index 8278b88c..b4ab31ea 100644 --- a/docs/payment_method/PaymentMethodAuthParameters.md +++ b/docs/payment_method/PaymentMethodAuthParameters.md @@ -1,10 +1,10 @@ # PaymentMethodAuthParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AuthCode** | **string** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AuthCode** | **string** | ☑️ | | | ## Methods diff --git a/docs/payment_method/PaymentMethodCountry.md b/docs/payment_method/PaymentMethodCountry.md index f6890d35..5f7d11b9 100644 --- a/docs/payment_method/PaymentMethodCountry.md +++ b/docs/payment_method/PaymentMethodCountry.md @@ -1,19 +1,21 @@ # PaymentMethodCountry -## Enum - -* `PH` (value: `"PH"`) - -* `ID` (value: `"ID"`) - -* `VN` (value: `"VN"`) - -* `TH` (value: `"TH"`) - -* `MY` (value: `"MY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `PH` (value: `"PH"`) + + * `ID` (value: `"ID"`) + + * `VN` (value: `"VN"`) + + * `TH` (value: `"TH"`) + + * `MY` (value: `"MY"`) + + * `US` (value: `"US"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/PaymentMethodExpireParameters.md b/docs/payment_method/PaymentMethodExpireParameters.md index f6538c86..b80d8a04 100644 --- a/docs/payment_method/PaymentMethodExpireParameters.md +++ b/docs/payment_method/PaymentMethodExpireParameters.md @@ -1,11 +1,11 @@ # PaymentMethodExpireParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **NullableString** | URL where the end customer is redirected if the unlinking authorization is successful. | [optional] | -| **FailureReturnUrl** | Pointer to **NullableString** | URL where the end customer is redirected if the unlinking authorization is failed. | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **NullableString** | | URL where the end customer is redirected if the unlinking authorization is successful. | | +| **FailureReturnUrl** | Pointer to **NullableString** | | URL where the end customer is redirected if the unlinking authorization is failed. | | ## Methods diff --git a/docs/payment_method/PaymentMethodList.md b/docs/payment_method/PaymentMethodList.md index 1ab66ab5..fe3fe1f5 100644 --- a/docs/payment_method/PaymentMethodList.md +++ b/docs/payment_method/PaymentMethodList.md @@ -1,11 +1,11 @@ # PaymentMethodList -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Data** | [**PaymentMethod[]**](PaymentMethod.md) | | | -| **HasMore** | Pointer to **bool** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Data** | [**PaymentMethod[]**](PaymentMethod.md) | ☑️ | | | +| **HasMore** | Pointer to **bool** | | | | ## Methods diff --git a/docs/payment_method/PaymentMethodParameters.md b/docs/payment_method/PaymentMethodParameters.md index b0bd8e6c..97ba3d16 100644 --- a/docs/payment_method/PaymentMethodParameters.md +++ b/docs/payment_method/PaymentMethodParameters.md @@ -1,23 +1,23 @@ # PaymentMethodParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | | | -| **Country** | Pointer to **NullableString** | | [optional] | -| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | -| **CustomerId** | Pointer to **NullableString** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **Card** | Pointer to [**CardParameters**](CardParameters.md) | | [optional] | -| **DirectDebit** | Pointer to [**DirectDebitParameters**](DirectDebitParameters.md) | | [optional] | -| **Ewallet** | Pointer to [**EWalletParameters**](EWalletParameters.md) | | [optional] | -| **OverTheCounter** | Pointer to [**OverTheCounterParameters**](OverTheCounterParameters.md) | | [optional] | -| **VirtualAccount** | Pointer to [**VirtualAccountParameters**](VirtualAccountParameters.md) | | [optional] | -| **QrCode** | Pointer to [**QRCodeParameters**](QRCodeParameters.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | -| **BillingInformation** | Pointer to [**NullableBillingInformation**](BillingInformation.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | +| **Country** | Pointer to **NullableString** | | | | +| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | +| **CustomerId** | Pointer to **NullableString** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **Description** | Pointer to **NullableString** | | | | +| **Card** | Pointer to [**CardParameters**](CardParameters.md) | | | | +| **DirectDebit** | Pointer to [**DirectDebitParameters**](DirectDebitParameters.md) | | | | +| **Ewallet** | Pointer to [**EWalletParameters**](EWalletParameters.md) | | | | +| **OverTheCounter** | Pointer to [**OverTheCounterParameters**](OverTheCounterParameters.md) | | | | +| **VirtualAccount** | Pointer to [**VirtualAccountParameters**](VirtualAccountParameters.md) | | | | +| **QrCode** | Pointer to [**QRCodeParameters**](QRCodeParameters.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | +| **BillingInformation** | Pointer to [**NullableBillingInformation**](BillingInformation.md) | | | | ## Methods diff --git a/docs/payment_method/PaymentMethodReusability.md b/docs/payment_method/PaymentMethodReusability.md index 22157bdb..a68670a1 100644 --- a/docs/payment_method/PaymentMethodReusability.md +++ b/docs/payment_method/PaymentMethodReusability.md @@ -1,13 +1,13 @@ # PaymentMethodReusability -## Enum - -* `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) - -* `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) + + * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/PaymentMethodStatus.md b/docs/payment_method/PaymentMethodStatus.md index 419179f3..6991ae04 100644 --- a/docs/payment_method/PaymentMethodStatus.md +++ b/docs/payment_method/PaymentMethodStatus.md @@ -1,21 +1,21 @@ # PaymentMethodStatus -## Enum - -* `ACTIVE` (value: `"ACTIVE"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `INACTIVE` (value: `"INACTIVE"`) - -* `PENDING` (value: `"PENDING"`) - -* `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) - -* `FAILED` (value: `"FAILED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `ACTIVE` (value: `"ACTIVE"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) + + * `FAILED` (value: `"FAILED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/PaymentMethodType.md b/docs/payment_method/PaymentMethodType.md index eb1e28de..293c8ae0 100644 --- a/docs/payment_method/PaymentMethodType.md +++ b/docs/payment_method/PaymentMethodType.md @@ -1,25 +1,25 @@ # PaymentMethodType -## Enum - -* `CARD` (value: `"CARD"`) - -* `CRYPTOCURRENCY` (value: `"CRYPTOCURRENCY"`) - -* `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) - -* `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) - -* `QR_CODE` (value: `"QR_CODE"`) - -* `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `CARD` (value: `"CARD"`) + + * `CRYPTOCURRENCY` (value: `"CRYPTOCURRENCY"`) + + * `DIRECT_BANK_TRANSFER` (value: `"DIRECT_BANK_TRANSFER"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/PaymentMethodUpdateParameters.md b/docs/payment_method/PaymentMethodUpdateParameters.md index 4fe26d5b..0e49ef74 100644 --- a/docs/payment_method/PaymentMethodUpdateParameters.md +++ b/docs/payment_method/PaymentMethodUpdateParameters.md @@ -1,15 +1,15 @@ # PaymentMethodUpdateParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Description** | Pointer to **string** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Reusability** | Pointer to [**PaymentMethodReusability**](PaymentMethodReusability.md) | | [optional] | -| **Status** | Pointer to [**PaymentMethodStatus**](PaymentMethodStatus.md) | | [optional] | -| **OverTheCounter** | Pointer to [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | [optional] | -| **VirtualAccount** | Pointer to [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Description** | Pointer to **string** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **Reusability** | Pointer to [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | | +| **Status** | Pointer to [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | | +| **OverTheCounter** | Pointer to [**OverTheCounterUpdateParameters**](OverTheCounterUpdateParameters.md) | | | | +| **VirtualAccount** | Pointer to [**VirtualAccountUpdateParameters**](VirtualAccountUpdateParameters.md) | | | | ## Methods diff --git a/docs/payment_method/QRCode.md b/docs/payment_method/QRCode.md index d209038a..9ed70534 100644 --- a/docs/payment_method/QRCode.md +++ b/docs/payment_method/QRCode.md @@ -1,13 +1,13 @@ # QRCode +QR Code Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**NullableQRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**NullableQRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | ## Methods diff --git a/docs/payment_method/QRCodeChannelCode.md b/docs/payment_method/QRCodeChannelCode.md index 908693d3..d93cfaeb 100644 --- a/docs/payment_method/QRCodeChannelCode.md +++ b/docs/payment_method/QRCodeChannelCode.md @@ -1,19 +1,19 @@ # QRCodeChannelCode - -## Enum - - -* `QRIS` (value: `"QRIS"`) - -* `DANA` (value: `"DANA"`) - -* `RCBC` (value: `"RCBC"`) - -* `PROMPTPAY` (value: `"PROMPTPAY"`) - -* `LINKAJA` (value: `"LINKAJA"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +QR Code Channel Code + + ## Enum + + * `QRIS` (value: `"QRIS"`) + + * `DANA` (value: `"DANA"`) + + * `RCBC` (value: `"RCBC"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/QRCodeChannelProperties.md b/docs/payment_method/QRCodeChannelProperties.md index 1b03ab64..f47ca434 100644 --- a/docs/payment_method/QRCodeChannelProperties.md +++ b/docs/payment_method/QRCodeChannelProperties.md @@ -1,11 +1,11 @@ # QRCodeChannelProperties +QR Code Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **QrString** | Pointer to **string** | QR string to be rendered for display to end users. QR string to image rendering are commonly available in software libraries (e.g Nodejs, PHP, Java) | [optional] | -| **ExpiresAt** | Pointer to **time.Time** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **QrString** | Pointer to **string** | | QR string to be rendered for display to end users. QR string to image rendering are commonly available in software libraries (e.g Nodejs, PHP, Java) | | +| **ExpiresAt** | Pointer to **time.Time** | | | | ## Methods diff --git a/docs/payment_method/QRCodeParameters.md b/docs/payment_method/QRCodeParameters.md index 75d8714e..122808d4 100644 --- a/docs/payment_method/QRCodeParameters.md +++ b/docs/payment_method/QRCodeParameters.md @@ -1,13 +1,13 @@ # QRCodeParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**NullableQRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**NullableQRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | ## Methods diff --git a/docs/payment_method/SimulatePaymentRequest.md b/docs/payment_method/SimulatePaymentRequest.md index b3fbce6a..96d5c34c 100644 --- a/docs/payment_method/SimulatePaymentRequest.md +++ b/docs/payment_method/SimulatePaymentRequest.md @@ -1,10 +1,10 @@ # SimulatePaymentRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **float64** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **float64** | | | | ## Methods diff --git a/docs/payment_method/TokenizedCardInformation.md b/docs/payment_method/TokenizedCardInformation.md index d40b6272..c997c028 100644 --- a/docs/payment_method/TokenizedCardInformation.md +++ b/docs/payment_method/TokenizedCardInformation.md @@ -1,19 +1,19 @@ # TokenizedCardInformation +Tokenized Card Information ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **TokenId** | **string** | | | -| **MaskedCardNumber** | **string** | 1st 6 and last 4 digits of the card | | -| **CardholderName** | Pointer to **NullableString** | Cardholder name is optional but recommended for 3DS 2 / AVS verification | [optional] | -| **ExpiryMonth** | **string** | Card expiry month in MM format | | -| **ExpiryYear** | **string** | Card expiry month in YY format | | -| **Fingerprint** | **string** | Xendit-generated identifier for the unique card number. Multiple payment method objects can be created for the same account - e.g. if the user first creates a one-time payment request, and then later on creates a multiple-use payment method using the same account. The fingerprint helps to identify the unique account being used. | | -| **Type** | **string** | Whether the card is a credit or debit card | | -| **Network** | **string** | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | | -| **Country** | **string** | Country where the card was issued ISO 3166-1 Alpha-2 | | -| **Issuer** | **string** | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **TokenId** | **string** | ☑️ | | | +| **MaskedCardNumber** | **string** | ☑️ | 1st 6 and last 4 digits of the card | | +| **CardholderName** | Pointer to **NullableString** | | Cardholder name is optional but recommended for 3DS 2 / AVS verification | | +| **ExpiryMonth** | **string** | ☑️ | Card expiry month in MM format | | +| **ExpiryYear** | **string** | ☑️ | Card expiry month in YY format | | +| **Fingerprint** | **string** | ☑️ | Xendit-generated identifier for the unique card number. Multiple payment method objects can be created for the same account - e.g. if the user first creates a one-time payment request, and then later on creates a multiple-use payment method using the same account. The fingerprint helps to identify the unique account being used. | | +| **Type** | **string** | ☑️ | Whether the card is a credit or debit card | | +| **Network** | **string** | ☑️ | Card network - VISA, MASTERCARD, JCB, AMEX, DISCOVER, BCA | | +| **Country** | **string** | ☑️ | Country where the card was issued ISO 3166-1 Alpha-2 | | +| **Issuer** | **string** | ☑️ | Issuer of the card, most often an issuing bank For example, “BCA”, “MANDIRI” | | ## Methods diff --git a/docs/payment_method/VirtualAccount.md b/docs/payment_method/VirtualAccount.md index d9b93d1b..d6359a83 100644 --- a/docs/payment_method/VirtualAccount.md +++ b/docs/payment_method/VirtualAccount.md @@ -1,17 +1,17 @@ # VirtualAccount +Virtual Account Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **AlternativeDisplayTypes** | Pointer to **string[]** | For payments in Vietnam only, alternative display requested for the virtual account | [optional] | -| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | +| **AlternativeDisplayTypes** | Pointer to **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | | +| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | | | ## Methods diff --git a/docs/payment_method/VirtualAccountAllOf.md b/docs/payment_method/VirtualAccountAllOf.md index 792f9b9a..0a418b8e 100644 --- a/docs/payment_method/VirtualAccountAllOf.md +++ b/docs/payment_method/VirtualAccountAllOf.md @@ -1,10 +1,10 @@ # VirtualAccountAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | | | ## Methods diff --git a/docs/payment_method/VirtualAccountAlternativeDisplay.md b/docs/payment_method/VirtualAccountAlternativeDisplay.md index df5b2e6c..48de451a 100644 --- a/docs/payment_method/VirtualAccountAlternativeDisplay.md +++ b/docs/payment_method/VirtualAccountAlternativeDisplay.md @@ -1,11 +1,11 @@ # VirtualAccountAlternativeDisplay +Alternative Display Object ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | Pointer to **string** | Type of the alternative display | [optional] [readonly] | -| **Data** | Pointer to **string** | Data payload of the given alternative display | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | Pointer to **string** | | Type of the alternative display | | +| **Data** | Pointer to **string** | | Data payload of the given alternative display | | ## Methods diff --git a/docs/payment_method/VirtualAccountChannelCode.md b/docs/payment_method/VirtualAccountChannelCode.md index 2a89dc13..c5b806bf 100644 --- a/docs/payment_method/VirtualAccountChannelCode.md +++ b/docs/payment_method/VirtualAccountChannelCode.md @@ -1,39 +1,41 @@ # VirtualAccountChannelCode - -## Enum - - -* `BCA` (value: `"BCA"`) - -* `BJB` (value: `"BJB"`) - -* `BNI` (value: `"BNI"`) - -* `BRI` (value: `"BRI"`) - -* `MANDIRI` (value: `"MANDIRI"`) - -* `PERMATA` (value: `"PERMATA"`) - -* `BSI` (value: `"BSI"`) - -* `CIMB` (value: `"CIMB"`) - -* `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) - -* `ARTAJASA` (value: `"ARTAJASA"`) - -* `PV` (value: `"PV"`) - -* `VIETCAPITAL` (value: `"VIETCAPITAL"`) - -* `WOORI` (value: `"WOORI"`) - -* `MSB` (value: `"MSB"`) - -* `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Virtual Account Channel Code + + ## Enum + + * `BCA` (value: `"BCA"`) + + * `BJB` (value: `"BJB"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `CIMB` (value: `"CIMB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `ARTAJASA` (value: `"ARTAJASA"`) + + * `PV` (value: `"PV"`) + + * `VIETCAPITAL` (value: `"VIETCAPITAL"`) + + * `WOORI` (value: `"WOORI"`) + + * `MSB` (value: `"MSB"`) + + * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) + + * `AMBANK` (value: `"AMBANK"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_method/VirtualAccountChannelProperties.md b/docs/payment_method/VirtualAccountChannelProperties.md index 5b6de558..d2b3f91c 100644 --- a/docs/payment_method/VirtualAccountChannelProperties.md +++ b/docs/payment_method/VirtualAccountChannelProperties.md @@ -1,13 +1,13 @@ # VirtualAccountChannelProperties +Virtual Account Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **CustomerName** | Pointer to **string** | Name of customer. | [optional] | -| **VirtualAccountNumber** | Pointer to **string** | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | [optional] | -| **ExpiresAt** | Pointer to **time.Time** | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | [optional] | -| **SuggestedAmount** | Pointer to **float64** | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **CustomerName** | Pointer to **string** | | Name of customer. | | +| **VirtualAccountNumber** | Pointer to **string** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | | +| **ExpiresAt** | Pointer to **time.Time** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | +| **SuggestedAmount** | Pointer to **float64** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | ## Methods diff --git a/docs/payment_method/VirtualAccountChannelPropertiesPatch.md b/docs/payment_method/VirtualAccountChannelPropertiesPatch.md index 8a238e65..bd912977 100644 --- a/docs/payment_method/VirtualAccountChannelPropertiesPatch.md +++ b/docs/payment_method/VirtualAccountChannelPropertiesPatch.md @@ -1,11 +1,11 @@ # VirtualAccountChannelPropertiesPatch +Virtual Account Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ExpiresAt** | Pointer to **time.Time** | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | [optional] | -| **SuggestedAmount** | Pointer to **float64** | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ExpiresAt** | Pointer to **time.Time** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | +| **SuggestedAmount** | Pointer to **float64** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | ## Methods diff --git a/docs/payment_method/VirtualAccountParameters.md b/docs/payment_method/VirtualAccountParameters.md index 94ee5156..e0cd3ce4 100644 --- a/docs/payment_method/VirtualAccountParameters.md +++ b/docs/payment_method/VirtualAccountParameters.md @@ -1,16 +1,16 @@ # VirtualAccountParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **AlternativeDisplayTypes** | Pointer to **string[]** | For payments in Vietnam only, alternative display requested for the virtual account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to **string** | | | | +| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | +| **AlternativeDisplayTypes** | Pointer to **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | | ## Methods diff --git a/docs/payment_method/VirtualAccountUpdateParameters.md b/docs/payment_method/VirtualAccountUpdateParameters.md index 3e98a1af..fbe1f38a 100644 --- a/docs/payment_method/VirtualAccountUpdateParameters.md +++ b/docs/payment_method/VirtualAccountUpdateParameters.md @@ -1,14 +1,14 @@ # VirtualAccountUpdateParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **ChannelProperties** | Pointer to [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | [optional] | -| **AlternativeDisplayTypes** | Pointer to **string[]** | For payments in Vietnam only, alternative display requested for the virtual account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **ChannelProperties** | Pointer to [**VirtualAccountChannelPropertiesPatch**](VirtualAccountChannelPropertiesPatch.md) | | | | +| **AlternativeDisplayTypes** | Pointer to **string[]** | | For payments in Vietnam only, alternative display requested for the virtual account | | ## Methods diff --git a/docs/payment_request.yaml b/docs/payment_request.yaml deleted file mode 100644 index f247ce2b..00000000 --- a/docs/payment_request.yaml +++ /dev/null @@ -1,2617 +0,0 @@ -openapi: 3.0.0 -info: - description: This API is used for Payment Requests - title: Payment Requests - version: 1.44.1 -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /payment_requests: - get: - description: Get all payment requests by filter - operationId: getAllPaymentRequests - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: true - in: query - name: reference_id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: customer_id - required: false - schema: - items: - type: string - type: array - style: form - - explode: true - in: query - name: limit - required: false - schema: - type: integer - style: form - - explode: true - in: query - name: before_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: after_id - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequestListResponse' - description: Request successful - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Get all payment requests by filter - tags: - - payment_request - post: - description: Create Payment Request - operationId: createPaymentRequest - parameters: - - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - examples: - E-Wallet One Time Payment via Redirect URL: - value: - reference_id: example-ref-1234 - amount: 15000 - currency: IDR - country: ID - payment_method: - type: EWALLET - ewallet: - channel_code: SHOPEEPAY - channel_properties: - success_return_url: https://redirect.me/success - reusability: ONE_TIME_USE - Fixed amount dynamic QR: - value: - reference_id: example-ref-1234 - amount: 15000 - currency: IDR - payment_method: - type: QR_CODE - reusability: ONE_TIME_USE - qr_code: - channel_code: “QRIS” - metadata: - sku: example-sku-1234 - Fixed amount single use Virtual Account: - value: - reference_id: example-ref-1234 - currency: IDR - amount: 15000 - country: ID - payment_method: - type: VIRTUAL_ACCOUNT - reusability: ONE_TIME_USE - reference_id: example-1234 - virtual_account: - channel_code: BNI - channel_properties: - customer_name: Ahmad Gunawan - expires_at: 2023-01-03T17:00:00Z - metadata: - sku: example-sku-1234 - Subsequent PH Direct Debit payments after account linking: - value: - reference_id: example-ref-1234 - amount: 1500 - currency: PHP - payment_method_id: pm-9685a196-81e9-4c73-8d62-97df5aab2762 - metadata: - sku: example-sku-1234 - Subsequent tokenized E-Wallet payments after account linking: - value: - reference_id: example-ref-1234 - amount: 15000 - currency: IDR - payment_method_id: pm-2b2c6092-2100-4843-a7fc-f5c7edac7efd - metadata: - sku: example-sku-1234 - schema: - $ref: '#/components/schemas/PaymentRequestParameters' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - description: Request successful - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Create Payment Request - tags: - - payment_request - /payment_requests/{paymentRequestId}: - get: - description: Get payment request by ID - operationId: getPaymentRequestByID - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - description: Request successful - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Get payment request by ID - tags: - - payment_request - /payment_requests/{paymentRequestId}/auth: - post: - description: Payment Request Authorize - operationId: authorizePaymentRequest - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequestAuthParameters' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Payment Request Authorize - tags: - - payment_request - /payment_requests/{paymentRequestId}/auth/resend: - post: - description: Payment Request Resend Auth - operationId: resendPaymentRequestAuth - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PaymentRequest' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Payment Request Resend Auth - tags: - - payment_request - /payment_requests/{paymentRequestId}/captures: - get: - description: Get Payment Request Capture - operationId: getPaymentRequestCaptures - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: true - in: query - name: limit - required: false - schema: - type: integer - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CaptureListResponse' - description: Request successful - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Get Payment Request Capture - tags: - - payment_request - post: - description: Payment Request Capture - operationId: capturePaymentRequest - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CaptureParameters' - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/Capture' - description: Capture created - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - "500": - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: Payment Request Capture - tags: - - payment_request -components: - parameters: - ForUserId: - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - IdempotencyKey: - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - PaymentRequestID: - explode: false - in: path - name: paymentRequestId - required: true - schema: - example: pr-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - responses: - UnexpectedError: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - schemas: - Error: - properties: - error_code: - enum: - - ACCOUNT_ACCESS_BLOCKED - - ADDRESS_VALIDATION_FAILED - - AMOUNT_MISMATCHED - - API_VALIDATION_ERROR - - AUTHENTICATION_FAILED - - AUTHENTICATION_REQUIRED - - CARD_DECLINED - - CHANNEL_CODE_NOT_SUPPORTED_ERROR - - CHANNEL_NOT_ACTIVATED - - CHANNEL_UNAVAILABLE - - COF_COMBINATION_NOT_ALLOWED_ERROR - - CURRENCY_MISMATCHED - - CUSTOMER_NOT_FOUND_ERROR - - CUSTOMER_PAYMENT_METHOD_MISMATCHED - - DATA_NOT_FOUND - - DATA_NOT_FOUND_ERROR - - DECLINED_BY_ISSUER - - DECLINED_BY_PROCESSOR - - DENIED_PERSON_LIST_MATCHED - - DUPLICATE_ERROR - - DUPLICATE_REFERENCE - - EXCEEDS_CAPTURABLE_AMOUNT - - EXPIRED_CARD - - EXPIRED_OTP_ERROR - - FEATURE_NOT_ACTIVATED - - IDEMPOTENCY_ERROR - - INACTIVE_OR_UNAUTHORIZED_CARD - - INSUFFICIENT_BALANCE - - INVALID_ACCOUNT_DETAILS - - INVALID_CVV - - INVALID_OTP_ERROR - - INVALID_PAYMENT_METHOD - - ISSUER_UNAVAILABLE - - MANUAL_CAPTURE_NOT_SUPPORTED - - MAX_ACCOUNT_LINKING - - MAX_AMOUNT_LIMIT_ERROR - - MAX_OTP_ATTEMPTS_ERROR - - OPERATION_NOT_ALLOWED - - OTP_DELIVERY_ERROR - - PAYMENT_METHOD_NOT_FOUND_ERROR - - PAYMENT_REQUEST_ALREADY_COMPLETED - - PAYMENT_REQUEST_ALREADY_FAILED - - PAYMENT_REQUEST_ALREADY_FULLY_CAPTURED - - PAYMENT_STATUS_FAILED - - PROCESSOR_CONFIGURATION_ERROR - - PROCESSOR_ERROR - - PROCESSOR_TEMPORARILY_UNAVAILABLE - - PROCESSOR_TIMEOUT - - REJECTED_BY_ACQUIRER - - SERVER_ERROR - - STOLEN_CARD - - STRONG_CUSTOMER_AUTHENTICATION_REQUIRED - - SUSPECTED_FRAUDULENT - - UNAUTHORIZED - - DUPLICATED_FIXED_PAYMENT_INSTRUMENT - nullable: true - type: string - message: - example: An internal server error occurred - nullable: true - type: string - type: object - PaymentRequestCountry: - enum: - - ID - - PH - - VN - - TH - - MY - type: string - PaymentRequestCurrency: - enum: - - IDR - - PHP - - VND - - THB - - MYR - type: string - PaymentMethodType: - enum: - - CARD - - DIRECT_DEBIT - - EWALLET - - OVER_THE_COUNTER - - QR_CODE - - VIRTUAL_ACCOUNT - type: string - CardChannelProperties: - description: Card Channel Properties - example: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - nullable: false - properties: - skip_three_d_secure: - description: To indicate whether to perform 3DS during the linking phase - example: false - nullable: true - type: boolean - success_return_url: - description: URL where the end-customer is redirected if the authorization - is successful - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - nullable: true - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - failure_return_url: - description: URL where the end-customer is redirected if the authorization - failed - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - nullable: true - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - cardonfile_type: - description: Type of “credential-on-file” / “card-on-file” payment being - made. Indicate that this payment uses a previously linked Payment Method - for charging. - example: RECURRING - nullable: true - type: string - merchant_id_tag: - description: Tag for a Merchant ID that you want to associate this payment - with. For merchants using their own MIDs to specify which MID they want - to use - type: string - type: object - CardInformation: - description: Card Information - example: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - nullable: false - properties: - token_id: - type: string - masked_card_number: - description: 1st 6 and last 4 digits of the card - type: string - expiry_month: - description: Card expiry month in MM format - type: string - expiry_year: - description: Card expiry month in YY format - type: string - cardholder_name: - description: Cardholder name - nullable: true - type: string - fingerprint: - type: string - type: - type: string - network: - enum: - - VISA - - MASTERCARD - - JCB - - AMEX - - DISCOVER - type: string - country: - type: string - issuer: - type: string - required: - - expiry_month - - expiry_year - - masked_card_number - - token_id - type: object - CardVerificationResultsThreeDSecure: - example: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - properties: - three_d_secure_flow: - enum: - - CHALLENGE - - FRICTIONLESS - nullable: true - type: string - eci_code: - nullable: true - type: string - three_d_secure_result: - nullable: true - type: string - three_d_secure_result_reason: - nullable: true - type: string - three_d_secure_version: - nullable: true - type: string - type: object - CardVerificationResults: - example: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - three_d_secure: - $ref: '#/components/schemas/CardVerificationResultsThreeDSecure' - cvv_result: - nullable: true - type: string - address_verification_result: - nullable: true - type: string - type: object - Card: - example: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - currency: - $ref: '#/components/schemas/PaymentRequestCurrency' - channel_properties: - $ref: '#/components/schemas/CardChannelProperties' - card_information: - $ref: '#/components/schemas/CardInformation' - card_verification_results: - $ref: '#/components/schemas/CardVerificationResults' - required: - - card_information - - channel_properties - - currency - type: object - DirectDebitChannelCode: - description: Direct Debit Channel Code - enum: - - BCA_KLIKPAY - - BCA_ONEKLIK - - BRI - - BNI - - MANDIRI - - BPI - - BDO - - CIMBNIAGA - - MTB - - RCBC - - UBP - - AUTODEBIT_UBP - - CHINABANK - - BAY - - KTB - - BBL - - SCB - - KBANK_MB - - BAY_MB - - KTB_MB - - BBL_MB - - SCB_MB - - BDO_EPAY - - AFFIN_FPX - - AGRO_FPX - - ALLIANCE_FPX - - AMBANK_FPX - - ISLAM_FPX - - MUAMALAT_FPX - - BOC_FPX - - RAKYAT_FPX - - BSN_FPX - - CIMB_FPX - - HLB_FPX - - HSBC_FPX - - KFH_FPX - - MAYB2E_FPX - - MAYB2U_FPX - - OCBC_FPX - - PUBLIC_FPX - - RHB_FPX - - SCH_FPX - - UOB_FPX - - AFFIN_FPX_BUSINESS - - AGRO_FPX_BUSINESS - - ALLIANCE_FPX_BUSINESS - - AMBANK_FPX_BUSINESS - - ISLAM_FPX_BUSINESS - - MUAMALAT_FPX_BUSINESS - - BNP_FPX_BUSINESS - - CIMB_FPX_BUSINESS - - CITIBANK_FPX_BUSINESS - - DEUTSCHE_FPX_BUSINESS - - HLB_FPX_BUSINESS - - HSBC_FPX_BUSINESS - - RAKYAT_FPX_BUSINESS - - KFH_FPX_BUSINESS - - MAYB2E_FPX_BUSINESS - - OCBC_FPX_BUSINESS - - PUBLIC_FPX_BUSINESS - - RHB_FPX_BUSINESS - - SCH_FPX_BUSINESS - - UOB_FPX_BUSINESS - example: BRI - type: string - DirectDebitChannelPropertiesBankRedirect: - description: Direct Debit Bank Account Channel Properties - example: - mobile_number: "0812345678" - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - properties: - mobile_number: - description: Mobile number of the customer that is registered to channel - type: string - success_return_url: - format: uri - type: string - failure_return_url: - format: uri - type: string - type: object - DirectDebitChannelPropertiesBankAccount: - description: Direct Debit Bank Account Channel Properties - example: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - properties: - success_return_url: - format: uri - type: string - failure_return_url: - format: uri - type: string - mobile_number: - type: string - identity_document_number: - type: string - type: object - DirectDebitChannelPropertiesDebitCard: - description: Direct Debit Debit Card Channel Properties - example: - mobile_number: +62818555988 - card_last_four: "8888" - card_expiry: 06/24 - email: test.email@xendit.co - properties: - mobile_number: - description: Mobile number of the customer registered to the partner channel - example: +62818555988 - type: string - account_number: - example: "1234567890" - type: string - card_last_four: - description: Last four digits of the debit card - example: "8888" - type: string - card_expiry: - description: Expiry month and year of the debit card (in MM/YY format) - example: 06/24 - type: string - email: - description: Email address of the customer that is registered to the partner - channel - example: test.email@xendit.co - type: string - type: object - DirectDebitChannelProperties: - anyOf: - - $ref: '#/components/schemas/DirectDebitChannelPropertiesBankRedirect' - - $ref: '#/components/schemas/DirectDebitChannelPropertiesBankAccount' - - $ref: '#/components/schemas/DirectDebitChannelPropertiesDebitCard' - nullable: true - DirectDebitType: - enum: - - DEBIT_CARD - - BANK_ACCOUNT - - BANK_REDIRECT - type: string - DirectDebitParameters: - example: - channel_properties: null - channel_code: BRI - type: null - nullable: true - properties: - channel_code: - $ref: '#/components/schemas/DirectDebitChannelCode' - channel_properties: - $ref: '#/components/schemas/DirectDebitChannelProperties' - type: - $ref: '#/components/schemas/DirectDebitType' - required: - - channel_code - - channel_properties - type: object - DirectDebitBankAccount: - nullable: true - properties: - masked_bank_account_number: - example: 233eca40ff303ba15bf39052ca3102c6 - nullable: true - type: string - bank_account_hash: - example: 233eca40ff303ba15bf39052ca3102c6 - nullable: true - type: string - type: object - DirectDebitDebitCard: - nullable: true - properties: - mobile_number: - description: Mobile number of the customer registered to the partner channel - example: +62818555988 - nullable: true - type: string - account_number: - example: "1234567890" - type: string - card_last_four: - description: Last four digits of the debit card - example: "8888" - nullable: true - type: string - card_expiry: - description: Expiry month and year of the debit card (in MM/YY format) - example: 06/24 - nullable: true - type: string - email: - description: Email address of the customer that is registered to the partner - channel - example: test.email@xendit.co - format: email - nullable: true - type: string - type: object - DirectDebit: - allOf: - - $ref: '#/components/schemas/DirectDebitParameters' - - $ref: '#/components/schemas/DirectDebit_allOf' - description: Direct Debit Payment Method Details - nullable: true - type: object - EWalletChannelCode: - description: Ewallet Channel Code - enum: - - GCASH - - GRABPAY - - PAYMAYA - - DANA - - OVO - - LINKAJA - - SHOPEEPAY - - NEXCASH - - ASTRAPAY - - JENIUSPAY - - APPOTA - - MOMO - - VNPTWALLET - - VIETTELPAY - - ZALOPAY - - WECHATPAY - - LINEPAY - - TRUEMONEY - - ALIPAY - example: PAYMAYA - type: string - EWalletChannelProperties: - description: Ewallet Channel Properties - example: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - nullable: false - properties: - success_return_url: - description: URL where the end-customer is redirected if the authorization - is successful - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - failure_return_url: - description: URL where the end-customer is redirected if the authorization - failed - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - cancel_return_url: - description: URL where the end-customer is redirected if the authorization - cancelled - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - redeem_points: - description: "REDEEM_NONE will not use any point, REDEEM_ALL will use all\ - \ available points before cash balance is used. For OVO and ShopeePay\ - \ tokenized payment use only." - example: REDEEM_NONE - type: string - mobile_number: - type: string - cashtag: - type: string - type: object - EWalletParameters: - example: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - channel_code: PAYMAYA - nullable: true - properties: - channel_code: - $ref: '#/components/schemas/EWalletChannelCode' - channel_properties: - $ref: '#/components/schemas/EWalletChannelProperties' - type: object - EWalletAccount: - description: EWallet Account Properties - example: - name: John Peter Doe - account_details: +63(2)123456XXXX - balance: null - point_balance: null - nullable: false - properties: - name: - description: Name of the eWallet account holder. The value is null if unavailableName - of the eWallet account holder. The value is null if unavailable - nullable: true - type: string - account_details: - description: Identifier from eWallet provider e.g. phone number. The value - is null if unavailable - nullable: true - type: string - balance: - description: The main balance amount on eWallet account provided from eWallet - provider. The value is null if unavailable - format: double - nullable: true - type: number - point_balance: - description: The point balance amount on eWallet account. Applicable only - on some eWallet provider that has point system. The value is null if unavailabl - format: double - nullable: true - type: number - type: object - EWallet: - allOf: - - $ref: '#/components/schemas/EWalletParameters' - - $ref: '#/components/schemas/EWallet_allOf' - description: Ewallet Payment Method Details - nullable: true - type: object - OverTheCounterChannelCode: - description: Over The Counter Channel Code - enum: - - 7ELEVEN - - 7ELEVEN_CLIQQ - - CEBUANA - - ECPAY - - PALAWAN - - MLHUILLIER - - ECPAY_DRAGONLOAN - - LBC - - ECPAY_SCHOOL - - RD_PAWNSHOP - - CVM - - USSC - - SM_BILLS - - ROBINSONS_BILLS - - ALFAMART - - INDOMARET - example: 7ELEVEN_CLIQQ - type: string - OverTheCounterChannelProperties: - description: Over The Counter Channel Properties - example: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - properties: - payment_code: - description: "The payment code that you want to assign, e.g 12345. If you\ - \ do not send one, one will be picked at random." - example: "12345" - type: string - customer_name: - description: Name of customer. - example: Rika Sutanto - type: string - expires_at: - description: The time when the payment code will be expired. The minimum - is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date - will be 2 days from payment code generated. - example: 2022-01-01T00:00:00Z - format: date-time - type: string - required: - - customer_name - type: object - OverTheCounterParameters: - example: - amount: 6.027456183070403 - currency: null - channel_properties: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - channel_code: 7ELEVEN_CLIQQ - nullable: true - properties: - amount: - format: double - nullable: true - type: number - currency: - $ref: '#/components/schemas/PaymentRequestCurrency' - channel_code: - $ref: '#/components/schemas/OverTheCounterChannelCode' - channel_properties: - $ref: '#/components/schemas/OverTheCounterChannelProperties' - required: - - channel_code - - channel_properties - type: object - OverTheCounter: - allOf: - - $ref: '#/components/schemas/OverTheCounterParameters' - description: Over the Counter Payment Method Details - nullable: true - type: object - VirtualAccountChannelCode: - description: Virtual Account Channel Code - enum: - - BCA - - BJB - - BNI - - BRI - - MANDIRI - - PERMATA - - BSI - - CIMB - - SAHABAT_SAMPOERNA - - ARTAJASA - - PV - - VIETCAPITAL - - WOORI - - MSB - - STANDARD_CHARTERED - example: BCA - type: string - VirtualAccountChannelProperties: - description: Virtual Account Channel Properties - example: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - properties: - customer_name: - description: Name of customer. - example: Rika Sutanto - type: string - virtual_account_number: - description: "You can assign specific Virtual Account number using this\ - \ parameter. If you do not send one, one will be picked at random. Make\ - \ sure the number you specify is within your Virtual Account range." - example: "262159999999999" - type: string - expires_at: - description: "The date and time in ISO 8601 UTC+0 when the virtual account\ - \ number will be expired. Default: The default expiration date will be\ - \ 31 years from creation date." - example: 2022-01-01T00:00:00Z - format: date-time - type: string - suggested_amount: - description: "The suggested amount you want to assign. Note: Suggested amounts\ - \ is the amounts that can see as a suggestion, but user can still put\ - \ any numbers (only supported for Mandiri and BRI)" - example: 100000 - format: double - type: number - required: - - customer_name - type: object - VirtualAccountParameters: - example: - amount: 5.637376656633329 - min_amount: 1.4658129805029452 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 5.962133916683182 - currency: null - channel_properties: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - channel_code: BCA - nullable: true - properties: - min_amount: - format: double - nullable: true - type: number - max_amount: - format: double - nullable: true - type: number - amount: - format: double - nullable: true - type: number - currency: - $ref: '#/components/schemas/PaymentRequestCurrency' - channel_code: - $ref: '#/components/schemas/VirtualAccountChannelCode' - channel_properties: - $ref: '#/components/schemas/VirtualAccountChannelProperties' - alternative_display_types: - description: Alternative display requested for the virtual account - items: - enum: - - QR_STRING - type: string - type: array - required: - - channel_code - - channel_properties - type: object - VirtualAccountAlternativeDisplay: - description: Alternative Display Object - properties: - type: - description: Type of the alternative display - enum: - - QR_STRING - readOnly: true - type: string - data: - description: Data payload of the given alternative display - type: string - type: object - VirtualAccount: - allOf: - - $ref: '#/components/schemas/VirtualAccountParameters' - - $ref: '#/components/schemas/VirtualAccount_allOf' - description: Virtual Account Payment Method Details - nullable: true - type: object - QRCodeChannelCode: - description: QR Code Channel Code - enum: - - DANA - - RCBC - - LINKAJA - - PROMPTPAY - example: RCBC - nullable: true - type: string - QRCodeChannelProperties: - description: QR Code Channel Properties - example: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - nullable: false - properties: - qr_string: - type: string - expires_at: - example: 2022-01-01T00:00:00Z - format: date-time - type: string - type: object - QRCodeParameters: - example: - channel_properties: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - channel_code: RCBC - nullable: true - properties: - channel_code: - $ref: '#/components/schemas/QRCodeChannelCode' - channel_properties: - $ref: '#/components/schemas/QRCodeChannelProperties' - type: object - QRCode: - allOf: - - $ref: '#/components/schemas/QRCodeParameters' - description: QRCode Payment Method Details - nullable: true - type: object - PaymentMethodReusability: - enum: - - MULTIPLE_USE - - ONE_TIME_USE - type: string - PaymentMethodStatus: - enum: - - ACTIVE - - INACTIVE - - PENDING - - EXPIRED - - FAILED - type: string - Object: - nullable: true - type: object - PaymentMethod: - example: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - nullable: false - properties: - id: - type: string - type: - $ref: '#/components/schemas/PaymentMethodType' - created: - type: string - updated: - type: string - description: - nullable: true - type: string - reference_id: - type: string - card: - $ref: '#/components/schemas/Card' - direct_debit: - $ref: '#/components/schemas/DirectDebit' - ewallet: - $ref: '#/components/schemas/EWallet' - over_the_counter: - $ref: '#/components/schemas/OverTheCounter' - virtual_account: - $ref: '#/components/schemas/VirtualAccount' - qr_code: - $ref: '#/components/schemas/QRCode' - reusability: - $ref: '#/components/schemas/PaymentMethodReusability' - status: - $ref: '#/components/schemas/PaymentMethodStatus' - metadata: - nullable: true - type: object - required: - - id - - reusability - - status - - type - type: object - PaymentRequestCaptureMethod: - enum: - - AUTOMATIC - - MANUAL - nullable: true - type: string - PaymentRequestInitiator: - enum: - - CUSTOMER - - MERCHANT - nullable: true - type: string - PaymentRequestCardVerificationResultsThreeDeeSecure: - example: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: three_d_secure_flow - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - three_d_secure_flow: - type: string - eci_code: - type: string - three_d_secure_result: - type: string - three_d_secure_result_reason: - nullable: true - type: string - three_d_secure_version: - type: string - type: object - PaymentRequestCardVerificationResults: - example: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: three_d_secure_flow - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - nullable: true - properties: - three_d_secure: - $ref: '#/components/schemas/PaymentRequestCardVerificationResultsThreeDeeSecure' - cvv_result: - nullable: true - type: string - address_verification_result: - nullable: true - type: string - required: - - three_d_secure - type: object - PaymentRequestStatus: - enum: - - PENDING - - REQUIRES_ACTION - - CANCELED - - SUCCEEDED - - FAILED - - VOIDED - - UNKNOWN - - AWAITING_CAPTURE - type: string - PaymentRequestAction: - example: - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - properties: - action: - enum: - - AUTH - - RESEND_AUTH - - CAPTURE - - CANCEL - - PRESENT_TO_CUSTOMER - type: string - url_type: - enum: - - API - - WEB - - MOBILE - - DEEPLINK - type: string - method: - nullable: true - type: string - url: - nullable: true - type: string - qr_code: - nullable: true - type: string - required: - - action - - method - - qr_code - - url - - url_type - type: object - PaymentRequestShippingInformation: - example: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - nullable: true - properties: - country: - type: string - street_line1: - type: string - street_line2: - type: string - city: - type: string - province_state: - type: string - postal_code: - type: string - required: - - country - type: object - PaymentRequestBasketItem: - example: - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - nullable: true - properties: - reference_id: - type: string - name: - type: string - description: - type: string - type: - type: string - category: - type: string - sub_category: - type: string - currency: - type: string - quantity: - format: double - type: number - price: - format: double - type: number - payer_charged_currency: - type: string - payer_charged_price: - format: double - type: number - url: - type: string - metadata: - type: object - required: - - category - - currency - - name - - price - - quantity - type: object - PaymentRequestBasket: - items: - $ref: '#/components/schemas/PaymentRequestBasketItem' - nullable: true - type: array - PaymentRequest: - example: - capture_method: null - country: null - amount: 0.8008281904610115 - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - min_amount: 6.027456183070403 - initiator: null - description: description - shipping_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - max_amount: 1.4658129805029452 - currency: null - id: id - customer_id: customer_id - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: three_d_secure_flow - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - updated: updated - business_id: business_id - actions: - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - items: - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - customer: "{}" - status: null - nullable: false - properties: - id: - type: string - created: - type: string - updated: - type: string - reference_id: - type: string - business_id: - type: string - customer_id: - nullable: true - type: string - customer: - nullable: true - type: object - amount: - format: double - type: number - min_amount: - format: double - nullable: true - type: number - max_amount: - format: double - nullable: true - type: number - country: - $ref: '#/components/schemas/PaymentRequestCountry' - currency: - $ref: '#/components/schemas/PaymentRequestCurrency' - payment_method: - $ref: '#/components/schemas/PaymentMethod' - description: - nullable: true - type: string - failure_code: - nullable: true - type: string - capture_method: - $ref: '#/components/schemas/PaymentRequestCaptureMethod' - initiator: - $ref: '#/components/schemas/PaymentRequestInitiator' - card_verification_results: - $ref: '#/components/schemas/PaymentRequestCardVerificationResults' - status: - $ref: '#/components/schemas/PaymentRequestStatus' - actions: - items: - $ref: '#/components/schemas/PaymentRequestAction' - type: array - metadata: - nullable: true - type: object - shipping_information: - $ref: '#/components/schemas/PaymentRequestShippingInformation' - items: - items: - $ref: '#/components/schemas/PaymentRequestBasketItem' - nullable: true - type: array - required: - - business_id - - created - - currency - - id - - payment_method - - reference_id - - status - - updated - type: object - PaymentRequestListResponse: - example: - data: - - capture_method: null - country: null - amount: 0.8008281904610115 - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - min_amount: 6.027456183070403 - initiator: null - description: description - shipping_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - max_amount: 1.4658129805029452 - currency: null - id: id - customer_id: customer_id - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: three_d_secure_flow - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - updated: updated - business_id: business_id - actions: - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - items: - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - customer: "{}" - status: null - - capture_method: null - country: null - amount: 0.8008281904610115 - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - min_amount: 6.027456183070403 - initiator: null - description: description - shipping_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - max_amount: 1.4658129805029452 - currency: null - id: id - customer_id: customer_id - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: three_d_secure_flow - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - updated: updated - business_id: business_id - actions: - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - - method: method - url_type: API - action: AUTH - qr_code: qr_code - url: url - items: - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - customer: "{}" - status: null - has_more: true - properties: - data: - items: - $ref: '#/components/schemas/PaymentRequest' - nullable: false - type: array - has_more: - type: boolean - required: - - data - - has_more - type: object - PaymentMethodParameters: - example: - ewallet: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - channel_code: PAYMAYA - reference_id: reference_id - over_the_counter: - amount: 6.027456183070403 - currency: null - channel_properties: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - channel_code: 7ELEVEN_CLIQQ - virtual_account: - amount: 5.637376656633329 - min_amount: 1.4658129805029452 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 5.962133916683182 - currency: null - channel_properties: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - channel_code: BCA - reusability: null - description: description - qr_code: - channel_properties: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - channel_code: RCBC - type: null - direct_debit: - channel_properties: null - channel_code: BRI - type: null - nullable: false - properties: - type: - $ref: '#/components/schemas/PaymentMethodType' - reusability: - $ref: '#/components/schemas/PaymentMethodReusability' - description: - nullable: true - type: string - reference_id: - type: string - direct_debit: - $ref: '#/components/schemas/DirectDebitParameters' - ewallet: - $ref: '#/components/schemas/EWalletParameters' - over_the_counter: - $ref: '#/components/schemas/OverTheCounterParameters' - virtual_account: - $ref: '#/components/schemas/VirtualAccountParameters' - qr_code: - $ref: '#/components/schemas/QRCodeParameters' - required: - - reusability - - type - type: object - PaymentRequestChannelProperties: - nullable: true - properties: - success_return_url: - description: URL where the end-customer is redirected if the authorization - is successful - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - failure_return_url: - description: URL where the end-customer is redirected if the authorization - failed - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - cancel_return_url: - description: URL where the end-customer is redirected if the authorization - cancelled - example: https://webhook.site/f4b755f5-4770-4a11-8c72-cc0b3cc6b882 - pattern: "^\\S{1,255}:\\/\\/\\S{0,1000}$" - type: string - redeem_points: - description: "REDEEM_NONE will not use any point, REDEEM_ALL will use all\ - \ available points before cash balance is used. For OVO and ShopeePay\ - \ tokenized payment use only." - example: REDEEM_NONE - type: string - require_auth: - description: "Toggle used to require end-customer to input undergo OTP validation\ - \ before completing a payment. OTP will always be required for transactions\ - \ greater than 1,000,000 IDR. For BRI tokenized payment use only." - example: false - type: boolean - merchant_id_tag: - description: 'Tag for a Merchant ID that you want to associate this payment - with. For merchants using their own MIDs to specify which MID they want - to use ' - type: string - cardonfile_type: - description: Type of “credential-on-file” / “card-on-file” payment being - made. Indicate that this payment uses a previously linked Payment Method - for charging. - example: RECURRING - nullable: true - type: string - type: object - PaymentRequestParameters: - example: - capture_method: null - amount: 0.8008281904610115 - metadata: "{}" - reference_id: reference_id - initiator: null - description: description - payment_method_id: payment_method_id - shipping_information: - country: country - city: city - province_state: province_state - street_line2: street_line2 - street_line1: street_line1 - postal_code: postal_code - currency: null - channel_properties: null - customer_id: customer_id - items: - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - - metadata: "{}" - quantity: 5.962133916683182 - reference_id: reference_id - sub_category: sub_category - description: description - type: type - url: url - price: 5.637376656633329 - name: name - payer_charged_price: 2.3021358869347655 - currency: currency - payer_charged_currency: payer_charged_currency - category: category - payment_method: - ewallet: - channel_properties: - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - cancel_return_url: https://redirect.me/cancel - channel_code: PAYMAYA - reference_id: reference_id - over_the_counter: - amount: 6.027456183070403 - currency: null - channel_properties: - payment_code: "12345" - customer_name: Rika Sutanto - expires_at: 2022-01-01T00:00:00Z - channel_code: 7ELEVEN_CLIQQ - virtual_account: - amount: 5.637376656633329 - min_amount: 1.4658129805029452 - alternative_display_types: - - QR_STRING - - QR_STRING - max_amount: 5.962133916683182 - currency: null - channel_properties: - customer_name: Rika Sutanto - description: Payment for SSS - expires_at: 2022-01-01T00:00:00Z - channel_code: BCA - reusability: null - description: description - qr_code: - channel_properties: - qr_string: 0002010102##########CO.XENDIT.WWW011893600#######14220002152#####414220010303TTT####015CO.XENDIT.WWW02180000000000000000000TTT52045######ID5911XenditQRIS6007Jakarta6105121606##########3k1mOnF73h11111111#3k1mOnF73h6v53033605401163040BDB - expires_at: 2022-01-01T00:00:00Z - channel_code: RCBC - type: null - direct_debit: - channel_properties: null - channel_code: BRI - type: null - customer: "{}" - nullable: false - properties: - reference_id: - type: string - amount: - format: double - type: number - currency: - $ref: '#/components/schemas/PaymentRequestCurrency' - payment_method: - $ref: '#/components/schemas/PaymentMethodParameters' - description: - nullable: true - type: string - capture_method: - $ref: '#/components/schemas/PaymentRequestCaptureMethod' - initiator: - $ref: '#/components/schemas/PaymentRequestInitiator' - payment_method_id: - type: string - channel_properties: - $ref: '#/components/schemas/PaymentRequestParameters_channel_properties' - shipping_information: - $ref: '#/components/schemas/PaymentRequestShippingInformation' - items: - items: - $ref: '#/components/schemas/PaymentRequestBasketItem' - nullable: true - type: array - customer_id: - nullable: true - type: string - customer: - nullable: true - type: object - metadata: - nullable: true - type: object - required: - - currency - type: object - PaymentRequestAuthParameters: - example: - auth_code: auth_code - nullable: false - properties: - auth_code: - type: string - required: - - auth_code - type: object - Capture: - example: - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - payment_request_id: payment_request_id - payment_id: payment_id - captured_amount: 6.027456183070403 - authorized_amount: 0.8008281904610115 - currency: currency - channel_properties: "{}" - id: id - customer_id: customer_id - updated: updated - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - status: SUCCEEDED - nullable: false - properties: - id: - type: string - payment_request_id: - type: string - payment_id: - type: string - reference_id: - type: string - currency: - type: string - authorized_amount: - format: double - type: number - captured_amount: - format: double - type: number - status: - enum: - - SUCCEEDED - - FAILED - type: string - payment_method: - $ref: '#/components/schemas/PaymentMethod' - failure_code: - nullable: true - type: string - customer_id: - nullable: true - type: string - metadata: - nullable: true - type: object - channel_properties: - nullable: true - type: object - created: - type: string - updated: - type: string - required: - - authorized_amount - - captured_amount - - channel_properties - - created - - currency - - customer_id - - failure_code - - id - - metadata - - payment_id - - payment_method - - payment_request_id - - reference_id - - status - - updated - type: object - CaptureList: - items: - $ref: '#/components/schemas/Capture' - nullable: false - type: array - CaptureListResponse: - example: - data: - - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - payment_request_id: payment_request_id - payment_id: payment_id - captured_amount: 6.027456183070403 - authorized_amount: 0.8008281904610115 - currency: currency - channel_properties: "{}" - id: id - customer_id: customer_id - updated: updated - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - status: SUCCEEDED - - failure_code: failure_code - metadata: "{}" - reference_id: reference_id - created: created - payment_request_id: payment_request_id - payment_id: payment_id - captured_amount: 6.027456183070403 - authorized_amount: 0.8008281904610115 - currency: currency - channel_properties: "{}" - id: id - customer_id: customer_id - updated: updated - payment_method: - metadata: "{}" - reference_id: reference_id - created: created - over_the_counter: null - description: description - reusability: null - type: null - direct_debit: null - ewallet: null - virtual_account: null - qr_code: null - id: id - updated: updated - card: - currency: null - channel_properties: - cardonfile_type: UNSCHEDULED - success_return_url: https://redirect.me/good - failure_return_url: https://redirect.me/bad - card_information: - expiry_month: expiry_month - country: country - token_id: token_id - fingerprint: fingerprint - masked_card_number: masked_card_number - cardholder_name: cardholder_name - type: type - expiry_year: expiry_year - issuer: issuer - network: VISA - card_verification_results: - cvv_result: cvv_result - address_verification_result: address_verification_result - three_d_secure: - eci_code: eci_code - three_d_secure_version: three_d_secure_version - three_d_secure_flow: CHALLENGE - three_d_secure_result: three_d_secure_result - three_d_secure_result_reason: three_d_secure_result_reason - status: null - status: SUCCEEDED - has_more: true - properties: - data: - items: - $ref: '#/components/schemas/Capture' - nullable: false - type: array - has_more: - type: boolean - required: - - data - - has_more - type: object - CaptureParameters: - example: - reference_id: reference_id - capture_amount: 0.8008281904610115 - nullable: false - properties: - reference_id: - nullable: true - type: string - capture_amount: - format: double - type: number - required: - - capture_amount - type: object - DirectDebit_allOf: - properties: - type: - $ref: '#/components/schemas/DirectDebitType' - bank_account: - $ref: '#/components/schemas/DirectDebitBankAccount' - debit_card: - $ref: '#/components/schemas/DirectDebitDebitCard' - required: - - type - type: object - example: null - EWallet_allOf: - properties: - account: - $ref: '#/components/schemas/EWalletAccount' - type: object - example: null - VirtualAccount_allOf: - properties: - alternative_displays: - items: - $ref: '#/components/schemas/VirtualAccountAlternativeDisplay' - type: array - type: object - example: null - PaymentRequestParameters_channel_properties_allOf: - properties: - cvv: - description: Three digit code written on the back of the card (usually called - CVV/CVN). - example: "123" - type: string - type: object - PaymentRequestParameters_channel_properties: - allOf: - - $ref: '#/components/schemas/PaymentRequestChannelProperties' - - $ref: '#/components/schemas/PaymentRequestParameters_channel_properties_allOf' diff --git a/docs/payment_request/Capture.md b/docs/payment_request/Capture.md index d47a9486..575284f3 100644 --- a/docs/payment_request/Capture.md +++ b/docs/payment_request/Capture.md @@ -1,24 +1,24 @@ # Capture -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | | | -| **PaymentRequestId** | **string** | | | -| **PaymentId** | **string** | | | -| **ReferenceId** | **string** | | | -| **Currency** | **string** | | | -| **AuthorizedAmount** | **float64** | | | -| **CapturedAmount** | **float64** | | | -| **Status** | **string** | | | -| **PaymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | | -| **FailureCode** | **NullableString** | | | -| **CustomerId** | **NullableString** | | | -| **Metadata** | **map[string]interface{}** | | | -| **ChannelProperties** | **map[string]interface{}** | | | -| **Created** | **string** | | | -| **Updated** | **string** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | | | +| **PaymentRequestId** | **string** | ☑️ | | | +| **PaymentId** | **string** | ☑️ | | | +| **ReferenceId** | **string** | ☑️ | | | +| **Currency** | **string** | ☑️ | | | +| **AuthorizedAmount** | **float64** | ☑️ | | | +| **CapturedAmount** | **float64** | ☑️ | | | +| **Status** | **string** | ☑️ | | | +| **PaymentMethod** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | +| **FailureCode** | **NullableString** | ☑️ | | | +| **CustomerId** | **NullableString** | ☑️ | | | +| **Metadata** | **map[string]interface{}** | ☑️ | | | +| **ChannelProperties** | **map[string]interface{}** | ☑️ | | | +| **Created** | **string** | ☑️ | | | +| **Updated** | **string** | ☑️ | | | ## Methods diff --git a/docs/payment_request/CaptureListResponse.md b/docs/payment_request/CaptureListResponse.md index 50c4edea..8e0d33e2 100644 --- a/docs/payment_request/CaptureListResponse.md +++ b/docs/payment_request/CaptureListResponse.md @@ -1,11 +1,11 @@ # CaptureListResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Data** | [**Capture[]**](Capture.md) | | | -| **HasMore** | **bool** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Data** | [**Capture[]**](Capture.md) | ☑️ | | | +| **HasMore** | **bool** | ☑️ | | | ## Methods diff --git a/docs/payment_request/CaptureParameters.md b/docs/payment_request/CaptureParameters.md index cbb8085e..7de6c274 100644 --- a/docs/payment_request/CaptureParameters.md +++ b/docs/payment_request/CaptureParameters.md @@ -1,11 +1,11 @@ # CaptureParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | Pointer to **NullableString** | | [optional] | -| **CaptureAmount** | **float64** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | Pointer to **NullableString** | | | | +| **CaptureAmount** | **float64** | ☑️ | | | ## Methods diff --git a/docs/payment_request/Card.md b/docs/payment_request/Card.md index f1627160..13a70132 100644 --- a/docs/payment_request/Card.md +++ b/docs/payment_request/Card.md @@ -1,13 +1,13 @@ # Card -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **ChannelProperties** | [**CardChannelProperties**](CardChannelProperties.md) | | | -| **CardInformation** | [**CardInformation**](CardInformation.md) | | | -| **CardVerificationResults** | Pointer to [**NullableCardVerificationResults**](CardVerificationResults.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | +| **ChannelProperties** | [**CardChannelProperties**](CardChannelProperties.md) | ☑️ | | | +| **CardInformation** | [**CardInformation**](CardInformation.md) | ☑️ | | | +| **CardVerificationResults** | Pointer to [**NullableCardVerificationResults**](CardVerificationResults.md) | | | | ## Methods diff --git a/docs/payment_request/CardChannelProperties.md b/docs/payment_request/CardChannelProperties.md index ce889ae6..7c0b50d9 100644 --- a/docs/payment_request/CardChannelProperties.md +++ b/docs/payment_request/CardChannelProperties.md @@ -1,14 +1,14 @@ # CardChannelProperties +Card Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SkipThreeDSecure** | Pointer to **NullableBool** | To indicate whether to perform 3DS during the linking phase | [optional] | -| **SuccessReturnUrl** | Pointer to **NullableString** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **NullableString** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CardonfileType** | Pointer to **NullableString** | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | [optional] | -| **MerchantIdTag** | Pointer to **string** | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SkipThreeDSecure** | Pointer to **NullableBool** | | To indicate whether to perform 3DS during the linking phase | | +| **SuccessReturnUrl** | Pointer to **NullableString** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **NullableString** | | URL where the end-customer is redirected if the authorization failed | | +| **CardonfileType** | Pointer to **NullableString** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | +| **MerchantIdTag** | Pointer to **string** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | ## Methods diff --git a/docs/payment_request/CardInformation.md b/docs/payment_request/CardInformation.md index ba6e5101..71ff1edb 100644 --- a/docs/payment_request/CardInformation.md +++ b/docs/payment_request/CardInformation.md @@ -1,19 +1,19 @@ # CardInformation +Card Information ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **TokenId** | **string** | | | -| **MaskedCardNumber** | **string** | 1st 6 and last 4 digits of the card | | -| **ExpiryMonth** | **string** | Card expiry month in MM format | | -| **ExpiryYear** | **string** | Card expiry month in YY format | | -| **CardholderName** | Pointer to **NullableString** | Cardholder name | [optional] | -| **Fingerprint** | Pointer to **string** | | [optional] | -| **Type** | Pointer to **string** | | [optional] | -| **Network** | Pointer to **string** | | [optional] | -| **Country** | Pointer to **string** | | [optional] | -| **Issuer** | Pointer to **string** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **TokenId** | **string** | ☑️ | | | +| **MaskedCardNumber** | **string** | ☑️ | 1st 6 and last 4 digits of the card | | +| **ExpiryMonth** | **string** | ☑️ | Card expiry month in MM format | | +| **ExpiryYear** | **string** | ☑️ | Card expiry month in YY format | | +| **CardholderName** | Pointer to **NullableString** | | Cardholder name | | +| **Fingerprint** | Pointer to **string** | | | | +| **Type** | Pointer to **string** | | | | +| **Network** | Pointer to **string** | | | | +| **Country** | Pointer to **string** | | | | +| **Issuer** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/CardVerificationResults.md b/docs/payment_request/CardVerificationResults.md index 391a4204..2f2c6e42 100644 --- a/docs/payment_request/CardVerificationResults.md +++ b/docs/payment_request/CardVerificationResults.md @@ -1,12 +1,12 @@ # CardVerificationResults -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecure** | Pointer to [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | [optional] | -| **CvvResult** | Pointer to **NullableString** | | [optional] | -| **AddressVerificationResult** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecure** | Pointer to [**CardVerificationResultsThreeDSecure**](CardVerificationResultsThreeDSecure.md) | | | | +| **CvvResult** | Pointer to **NullableString** | | | | +| **AddressVerificationResult** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_request/CardVerificationResultsThreeDSecure.md b/docs/payment_request/CardVerificationResultsThreeDSecure.md index bbdbeacb..decf50da 100644 --- a/docs/payment_request/CardVerificationResultsThreeDSecure.md +++ b/docs/payment_request/CardVerificationResultsThreeDSecure.md @@ -1,14 +1,14 @@ # CardVerificationResultsThreeDSecure -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecureFlow** | Pointer to **NullableString** | | [optional] | -| **EciCode** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureResult** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureResultReason** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureVersion** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecureFlow** | Pointer to **NullableString** | | | | +| **EciCode** | Pointer to **NullableString** | | | | +| **ThreeDSecureResult** | Pointer to **NullableString** | | | | +| **ThreeDSecureResultReason** | Pointer to **NullableString** | | | | +| **ThreeDSecureVersion** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_request/DirectDebit.md b/docs/payment_request/DirectDebit.md index bac4f451..b1e73860 100644 --- a/docs/payment_request/DirectDebit.md +++ b/docs/payment_request/DirectDebit.md @@ -1,14 +1,14 @@ # DirectDebit +Direct Debit Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | -| **Type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | +| **Type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | +| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | ## Methods diff --git a/docs/payment_request/DirectDebitAllOf.md b/docs/payment_request/DirectDebitAllOf.md index a3f8b08e..08719b9c 100644 --- a/docs/payment_request/DirectDebitAllOf.md +++ b/docs/payment_request/DirectDebitAllOf.md @@ -1,12 +1,12 @@ # DirectDebitAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | [**DirectDebitType**](DirectDebitType.md) | | | -| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | [optional] | -| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | [**DirectDebitType**](DirectDebitType.md) | ☑️ | | | +| **BankAccount** | Pointer to [**NullableDirectDebitBankAccount**](DirectDebitBankAccount.md) | | | | +| **DebitCard** | Pointer to [**NullableDirectDebitDebitCard**](DirectDebitDebitCard.md) | | | | ## Methods diff --git a/docs/payment_request/DirectDebitBankAccount.md b/docs/payment_request/DirectDebitBankAccount.md index 39caeaf3..9caff11e 100644 --- a/docs/payment_request/DirectDebitBankAccount.md +++ b/docs/payment_request/DirectDebitBankAccount.md @@ -1,11 +1,11 @@ # DirectDebitBankAccount -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MaskedBankAccountNumber** | Pointer to **NullableString** | | [optional] | -| **BankAccountHash** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MaskedBankAccountNumber** | Pointer to **NullableString** | | | | +| **BankAccountHash** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_request/DirectDebitChannelCode.md b/docs/payment_request/DirectDebitChannelCode.md index 9477a335..5bdecb53 100644 --- a/docs/payment_request/DirectDebitChannelCode.md +++ b/docs/payment_request/DirectDebitChannelCode.md @@ -1,135 +1,135 @@ # DirectDebitChannelCode - -## Enum - - -* `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) - -* `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) - -* `BRI` (value: `"BRI"`) - -* `BNI` (value: `"BNI"`) - -* `MANDIRI` (value: `"MANDIRI"`) - -* `BPI` (value: `"BPI"`) - -* `BDO` (value: `"BDO"`) - -* `CIMBNIAGA` (value: `"CIMBNIAGA"`) - -* `MTB` (value: `"MTB"`) - -* `RCBC` (value: `"RCBC"`) - -* `UBP` (value: `"UBP"`) - -* `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) - -* `CHINABANK` (value: `"CHINABANK"`) - -* `BAY` (value: `"BAY"`) - -* `KTB` (value: `"KTB"`) - -* `BBL` (value: `"BBL"`) - -* `SCB` (value: `"SCB"`) - -* `KBANK_MB` (value: `"KBANK_MB"`) - -* `BAY_MB` (value: `"BAY_MB"`) - -* `KTB_MB` (value: `"KTB_MB"`) - -* `BBL_MB` (value: `"BBL_MB"`) - -* `SCB_MB` (value: `"SCB_MB"`) - -* `BDO_EPAY` (value: `"BDO_EPAY"`) - -* `AFFIN_FPX` (value: `"AFFIN_FPX"`) - -* `AGRO_FPX` (value: `"AGRO_FPX"`) - -* `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) - -* `AMBANK_FPX` (value: `"AMBANK_FPX"`) - -* `ISLAM_FPX` (value: `"ISLAM_FPX"`) - -* `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) - -* `BOC_FPX` (value: `"BOC_FPX"`) - -* `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) - -* `BSN_FPX` (value: `"BSN_FPX"`) - -* `CIMB_FPX` (value: `"CIMB_FPX"`) - -* `HLB_FPX` (value: `"HLB_FPX"`) - -* `HSBC_FPX` (value: `"HSBC_FPX"`) - -* `KFH_FPX` (value: `"KFH_FPX"`) - -* `MAYB2_E_FPX` (value: `"MAYB2E_FPX"`) - -* `MAYB2_U_FPX` (value: `"MAYB2U_FPX"`) - -* `OCBC_FPX` (value: `"OCBC_FPX"`) - -* `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) - -* `RHB_FPX` (value: `"RHB_FPX"`) - -* `SCH_FPX` (value: `"SCH_FPX"`) - -* `UOB_FPX` (value: `"UOB_FPX"`) - -* `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) - -* `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) - -* `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) - -* `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) - -* `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) - -* `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) - -* `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) - -* `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) - -* `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) - -* `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) - -* `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) - -* `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) - -* `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) - -* `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) - -* `MAYB2_E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) - -* `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) - -* `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) - -* `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) - -* `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) - -* `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Direct Debit Channel Code + + ## Enum + + * `BCA_KLIKPAY` (value: `"BCA_KLIKPAY"`) + + * `BCA_ONEKLIK` (value: `"BCA_ONEKLIK"`) + + * `BRI` (value: `"BRI"`) + + * `BNI` (value: `"BNI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `BPI` (value: `"BPI"`) + + * `BDO` (value: `"BDO"`) + + * `CIMBNIAGA` (value: `"CIMBNIAGA"`) + + * `MTB` (value: `"MTB"`) + + * `RCBC` (value: `"RCBC"`) + + * `UBP` (value: `"UBP"`) + + * `AUTODEBIT_UBP` (value: `"AUTODEBIT_UBP"`) + + * `CHINABANK` (value: `"CHINABANK"`) + + * `BAY` (value: `"BAY"`) + + * `KTB` (value: `"KTB"`) + + * `BBL` (value: `"BBL"`) + + * `SCB` (value: `"SCB"`) + + * `KBANK_MB` (value: `"KBANK_MB"`) + + * `BAY_MB` (value: `"BAY_MB"`) + + * `KTB_MB` (value: `"KTB_MB"`) + + * `BBL_MB` (value: `"BBL_MB"`) + + * `SCB_MB` (value: `"SCB_MB"`) + + * `BDO_EPAY` (value: `"BDO_EPAY"`) + + * `AFFIN_FPX` (value: `"AFFIN_FPX"`) + + * `AGRO_FPX` (value: `"AGRO_FPX"`) + + * `ALLIANCE_FPX` (value: `"ALLIANCE_FPX"`) + + * `AMBANK_FPX` (value: `"AMBANK_FPX"`) + + * `ISLAM_FPX` (value: `"ISLAM_FPX"`) + + * `MUAMALAT_FPX` (value: `"MUAMALAT_FPX"`) + + * `BOC_FPX` (value: `"BOC_FPX"`) + + * `RAKYAT_FPX` (value: `"RAKYAT_FPX"`) + + * `BSN_FPX` (value: `"BSN_FPX"`) + + * `CIMB_FPX` (value: `"CIMB_FPX"`) + + * `HLB_FPX` (value: `"HLB_FPX"`) + + * `HSBC_FPX` (value: `"HSBC_FPX"`) + + * `KFH_FPX` (value: `"KFH_FPX"`) + + * `MAYB2_E_FPX` (value: `"MAYB2E_FPX"`) + + * `MAYB2_U_FPX` (value: `"MAYB2U_FPX"`) + + * `OCBC_FPX` (value: `"OCBC_FPX"`) + + * `PUBLIC_FPX` (value: `"PUBLIC_FPX"`) + + * `RHB_FPX` (value: `"RHB_FPX"`) + + * `SCH_FPX` (value: `"SCH_FPX"`) + + * `UOB_FPX` (value: `"UOB_FPX"`) + + * `AFFIN_FPX_BUSINESS` (value: `"AFFIN_FPX_BUSINESS"`) + + * `AGRO_FPX_BUSINESS` (value: `"AGRO_FPX_BUSINESS"`) + + * `ALLIANCE_FPX_BUSINESS` (value: `"ALLIANCE_FPX_BUSINESS"`) + + * `AMBANK_FPX_BUSINESS` (value: `"AMBANK_FPX_BUSINESS"`) + + * `ISLAM_FPX_BUSINESS` (value: `"ISLAM_FPX_BUSINESS"`) + + * `MUAMALAT_FPX_BUSINESS` (value: `"MUAMALAT_FPX_BUSINESS"`) + + * `BNP_FPX_BUSINESS` (value: `"BNP_FPX_BUSINESS"`) + + * `CIMB_FPX_BUSINESS` (value: `"CIMB_FPX_BUSINESS"`) + + * `CITIBANK_FPX_BUSINESS` (value: `"CITIBANK_FPX_BUSINESS"`) + + * `DEUTSCHE_FPX_BUSINESS` (value: `"DEUTSCHE_FPX_BUSINESS"`) + + * `HLB_FPX_BUSINESS` (value: `"HLB_FPX_BUSINESS"`) + + * `HSBC_FPX_BUSINESS` (value: `"HSBC_FPX_BUSINESS"`) + + * `RAKYAT_FPX_BUSINESS` (value: `"RAKYAT_FPX_BUSINESS"`) + + * `KFH_FPX_BUSINESS` (value: `"KFH_FPX_BUSINESS"`) + + * `MAYB2_E_FPX_BUSINESS` (value: `"MAYB2E_FPX_BUSINESS"`) + + * `OCBC_FPX_BUSINESS` (value: `"OCBC_FPX_BUSINESS"`) + + * `PUBLIC_FPX_BUSINESS` (value: `"PUBLIC_FPX_BUSINESS"`) + + * `RHB_FPX_BUSINESS` (value: `"RHB_FPX_BUSINESS"`) + + * `SCH_FPX_BUSINESS` (value: `"SCH_FPX_BUSINESS"`) + + * `UOB_FPX_BUSINESS` (value: `"UOB_FPX_BUSINESS"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/DirectDebitChannelProperties.md b/docs/payment_request/DirectDebitChannelProperties.md index 98ad7d4a..7c94cd67 100644 --- a/docs/payment_request/DirectDebitChannelProperties.md +++ b/docs/payment_request/DirectDebitChannelProperties.md @@ -1,17 +1,17 @@ # DirectDebitChannelProperties -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MobileNumber** | Pointer to **string** | Mobile number of the customer registered to the partner channel | [optional] | -| **SuccessReturnUrl** | Pointer to **string** | | [optional] | -| **FailureReturnUrl** | Pointer to **string** | | [optional] | -| **IdentityDocumentNumber** | Pointer to **string** | | [optional] | -| **AccountNumber** | Pointer to **string** | | [optional] | -| **CardLastFour** | Pointer to **string** | Last four digits of the debit card | [optional] | -| **CardExpiry** | Pointer to **string** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **Email** | Pointer to **string** | Email address of the customer that is registered to the partner channel | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MobileNumber** | Pointer to **string** | | Mobile number of the customer registered to the partner channel | | +| **SuccessReturnUrl** | Pointer to **string** | | | | +| **FailureReturnUrl** | Pointer to **string** | | | | +| **IdentityDocumentNumber** | Pointer to **string** | | | | +| **AccountNumber** | Pointer to **string** | | | | +| **CardLastFour** | Pointer to **string** | | Last four digits of the debit card | | +| **CardExpiry** | Pointer to **string** | | Expiry month and year of the debit card (in MM/YY format) | | +| **Email** | Pointer to **string** | | Email address of the customer that is registered to the partner channel | | ## Methods diff --git a/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md b/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md index 37b212d6..7652206c 100644 --- a/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md +++ b/docs/payment_request/DirectDebitChannelPropertiesBankAccount.md @@ -1,13 +1,13 @@ # DirectDebitChannelPropertiesBankAccount +Direct Debit Bank Account Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | | [optional] | -| **FailureReturnUrl** | Pointer to **string** | | [optional] | -| **MobileNumber** | Pointer to **string** | | [optional] | -| **IdentityDocumentNumber** | Pointer to **string** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | | | +| **FailureReturnUrl** | Pointer to **string** | | | | +| **MobileNumber** | Pointer to **string** | | | | +| **IdentityDocumentNumber** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md b/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md index 8b9fc24c..3acfea1a 100644 --- a/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md +++ b/docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md @@ -1,12 +1,12 @@ # DirectDebitChannelPropertiesBankRedirect +Direct Debit Bank Account Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MobileNumber** | Pointer to **string** | Mobile number of the customer that is registered to channel | [optional] | -| **SuccessReturnUrl** | Pointer to **string** | | [optional] | -| **FailureReturnUrl** | Pointer to **string** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MobileNumber** | Pointer to **string** | | Mobile number of the customer that is registered to channel | | +| **SuccessReturnUrl** | Pointer to **string** | | | | +| **FailureReturnUrl** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md b/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md index 09a5092f..65b398c3 100644 --- a/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md +++ b/docs/payment_request/DirectDebitChannelPropertiesDebitCard.md @@ -1,14 +1,14 @@ # DirectDebitChannelPropertiesDebitCard +Direct Debit Debit Card Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MobileNumber** | Pointer to **string** | Mobile number of the customer registered to the partner channel | [optional] | -| **AccountNumber** | Pointer to **string** | | [optional] | -| **CardLastFour** | Pointer to **string** | Last four digits of the debit card | [optional] | -| **CardExpiry** | Pointer to **string** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **Email** | Pointer to **string** | Email address of the customer that is registered to the partner channel | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MobileNumber** | Pointer to **string** | | Mobile number of the customer registered to the partner channel | | +| **AccountNumber** | Pointer to **string** | | | | +| **CardLastFour** | Pointer to **string** | | Last four digits of the debit card | | +| **CardExpiry** | Pointer to **string** | | Expiry month and year of the debit card (in MM/YY format) | | +| **Email** | Pointer to **string** | | Email address of the customer that is registered to the partner channel | | ## Methods diff --git a/docs/payment_request/DirectDebitDebitCard.md b/docs/payment_request/DirectDebitDebitCard.md index 4a38f2f7..b62f118e 100644 --- a/docs/payment_request/DirectDebitDebitCard.md +++ b/docs/payment_request/DirectDebitDebitCard.md @@ -1,14 +1,14 @@ # DirectDebitDebitCard -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MobileNumber** | Pointer to **NullableString** | Mobile number of the customer registered to the partner channel | [optional] | -| **AccountNumber** | Pointer to **string** | | [optional] | -| **CardLastFour** | Pointer to **NullableString** | Last four digits of the debit card | [optional] | -| **CardExpiry** | Pointer to **NullableString** | Expiry month and year of the debit card (in MM/YY format) | [optional] | -| **Email** | Pointer to **NullableString** | Email address of the customer that is registered to the partner channel | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MobileNumber** | Pointer to **NullableString** | | Mobile number of the customer registered to the partner channel | | +| **AccountNumber** | Pointer to **string** | | | | +| **CardLastFour** | Pointer to **NullableString** | | Last four digits of the debit card | | +| **CardExpiry** | Pointer to **NullableString** | | Expiry month and year of the debit card (in MM/YY format) | | +| **Email** | Pointer to **NullableString** | | Email address of the customer that is registered to the partner channel | | ## Methods diff --git a/docs/payment_request/DirectDebitParameters.md b/docs/payment_request/DirectDebitParameters.md index 2bdcf6ac..c0e9a5fa 100644 --- a/docs/payment_request/DirectDebitParameters.md +++ b/docs/payment_request/DirectDebitParameters.md @@ -1,12 +1,12 @@ # DirectDebitParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | | | -| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | | | -| **Type** | Pointer to [**DirectDebitType**](DirectDebitType.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | [**DirectDebitChannelCode**](DirectDebitChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**NullableDirectDebitChannelProperties**](DirectDebitChannelProperties.md) | ☑️ | | | +| **Type** | Pointer to [**DirectDebitType**](DirectDebitType.md) | | | | ## Methods diff --git a/docs/payment_request/DirectDebitType.md b/docs/payment_request/DirectDebitType.md index 71b174c0..4dae3ad5 100644 --- a/docs/payment_request/DirectDebitType.md +++ b/docs/payment_request/DirectDebitType.md @@ -1,15 +1,15 @@ # DirectDebitType -## Enum - -* `DEBIT_CARD` (value: `"DEBIT_CARD"`) - -* `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) - -* `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `DEBIT_CARD` (value: `"DEBIT_CARD"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `BANK_REDIRECT` (value: `"BANK_REDIRECT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/EWallet.md b/docs/payment_request/EWallet.md index 482e7063..ee116a41 100644 --- a/docs/payment_request/EWallet.md +++ b/docs/payment_request/EWallet.md @@ -1,12 +1,12 @@ # EWallet +Ewallet Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | Pointer to [**EWalletChannelCode**](EWalletChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | -| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | Pointer to [**EWalletChannelCode**](EWalletChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | +| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | | | ## Methods diff --git a/docs/payment_request/EWalletAccount.md b/docs/payment_request/EWalletAccount.md index 445abbb5..d51f2850 100644 --- a/docs/payment_request/EWalletAccount.md +++ b/docs/payment_request/EWalletAccount.md @@ -1,13 +1,13 @@ # EWalletAccount +EWallet Account Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Name** | Pointer to **NullableString** | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | [optional] | -| **AccountDetails** | Pointer to **NullableString** | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | [optional] | -| **Balance** | Pointer to **NullableFloat64** | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | [optional] | -| **PointBalance** | Pointer to **NullableFloat64** | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Name** | Pointer to **NullableString** | | Name of the eWallet account holder. The value is null if unavailableName of the eWallet account holder. The value is null if unavailable | | +| **AccountDetails** | Pointer to **NullableString** | | Identifier from eWallet provider e.g. phone number. The value is null if unavailable | | +| **Balance** | Pointer to **NullableFloat64** | | The main balance amount on eWallet account provided from eWallet provider. The value is null if unavailable | | +| **PointBalance** | Pointer to **NullableFloat64** | | The point balance amount on eWallet account. Applicable only on some eWallet provider that has point system. The value is null if unavailabl | | ## Methods diff --git a/docs/payment_request/EWalletAllOf.md b/docs/payment_request/EWalletAllOf.md index 3aa29dfe..b3cfe9d7 100644 --- a/docs/payment_request/EWalletAllOf.md +++ b/docs/payment_request/EWalletAllOf.md @@ -1,10 +1,10 @@ # EWalletAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Account** | Pointer to [**EWalletAccount**](EWalletAccount.md) | | | | ## Methods diff --git a/docs/payment_request/EWalletChannelCode.md b/docs/payment_request/EWalletChannelCode.md index c6f67fd6..db774df5 100644 --- a/docs/payment_request/EWalletChannelCode.md +++ b/docs/payment_request/EWalletChannelCode.md @@ -1,47 +1,49 @@ # EWalletChannelCode - -## Enum - - -* `GCASH` (value: `"GCASH"`) - -* `GRABPAY` (value: `"GRABPAY"`) - -* `PAYMAYA` (value: `"PAYMAYA"`) - -* `DANA` (value: `"DANA"`) - -* `OVO` (value: `"OVO"`) - -* `LINKAJA` (value: `"LINKAJA"`) - -* `SHOPEEPAY` (value: `"SHOPEEPAY"`) - -* `NEXCASH` (value: `"NEXCASH"`) - -* `ASTRAPAY` (value: `"ASTRAPAY"`) - -* `JENIUSPAY` (value: `"JENIUSPAY"`) - -* `APPOTA` (value: `"APPOTA"`) - -* `MOMO` (value: `"MOMO"`) - -* `VNPTWALLET` (value: `"VNPTWALLET"`) - -* `VIETTELPAY` (value: `"VIETTELPAY"`) - -* `ZALOPAY` (value: `"ZALOPAY"`) - -* `WECHATPAY` (value: `"WECHATPAY"`) - -* `LINEPAY` (value: `"LINEPAY"`) - -* `TRUEMONEY` (value: `"TRUEMONEY"`) - -* `ALIPAY` (value: `"ALIPAY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Ewallet Channel Code + + ## Enum + + * `GCASH` (value: `"GCASH"`) + + * `GRABPAY` (value: `"GRABPAY"`) + + * `PAYMAYA` (value: `"PAYMAYA"`) + + * `DANA` (value: `"DANA"`) + + * `OVO` (value: `"OVO"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `SHOPEEPAY` (value: `"SHOPEEPAY"`) + + * `NEXCASH` (value: `"NEXCASH"`) + + * `ASTRAPAY` (value: `"ASTRAPAY"`) + + * `JENIUSPAY` (value: `"JENIUSPAY"`) + + * `APPOTA` (value: `"APPOTA"`) + + * `MOMO` (value: `"MOMO"`) + + * `VNPTWALLET` (value: `"VNPTWALLET"`) + + * `VIETTELPAY` (value: `"VIETTELPAY"`) + + * `ZALOPAY` (value: `"ZALOPAY"`) + + * `WECHATPAY` (value: `"WECHATPAY"`) + + * `LINEPAY` (value: `"LINEPAY"`) + + * `TRUEMONEY` (value: `"TRUEMONEY"`) + + * `ALIPAY` (value: `"ALIPAY"`) + + * `TOUCHANDGO` (value: `"TOUCHANDGO"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/EWalletChannelProperties.md b/docs/payment_request/EWalletChannelProperties.md index 9f1b3ef7..ddd76501 100644 --- a/docs/payment_request/EWalletChannelProperties.md +++ b/docs/payment_request/EWalletChannelProperties.md @@ -1,15 +1,15 @@ # EWalletChannelProperties +Ewallet Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CancelReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **RedeemPoints** | Pointer to **string** | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | [optional] | -| **MobileNumber** | Pointer to **string** | | [optional] | -| **Cashtag** | Pointer to **string** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization failed | | +| **CancelReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization cancelled | | +| **RedeemPoints** | Pointer to **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | +| **MobileNumber** | Pointer to **string** | | | | +| **Cashtag** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/EWalletParameters.md b/docs/payment_request/EWalletParameters.md index 51b40631..a81ef0bf 100644 --- a/docs/payment_request/EWalletParameters.md +++ b/docs/payment_request/EWalletParameters.md @@ -1,11 +1,11 @@ # EWalletParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | Pointer to [**EWalletChannelCode**](EWalletChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | Pointer to [**EWalletChannelCode**](EWalletChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**EWalletChannelProperties**](EWalletChannelProperties.md) | | | | ## Methods diff --git a/docs/payment_request/Error.md b/docs/payment_request/Error.md index eea6015f..eeaca209 100644 --- a/docs/payment_request/Error.md +++ b/docs/payment_request/Error.md @@ -1,11 +1,11 @@ # Error -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **NullableString** | | [optional] | -| **Message** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **NullableString** | | | | +| **Message** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_request/OverTheCounter.md b/docs/payment_request/OverTheCounter.md index 84386d93..9f5b5292 100644 --- a/docs/payment_request/OverTheCounter.md +++ b/docs/payment_request/OverTheCounter.md @@ -1,13 +1,13 @@ # OverTheCounter +Over the Counter Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | ## Methods diff --git a/docs/payment_request/OverTheCounterChannelCode.md b/docs/payment_request/OverTheCounterChannelCode.md index d581279d..13a38af3 100644 --- a/docs/payment_request/OverTheCounterChannelCode.md +++ b/docs/payment_request/OverTheCounterChannelCode.md @@ -1,41 +1,41 @@ # OverTheCounterChannelCode - -## Enum - - -* `_7_ELEVEN` (value: `"7ELEVEN"`) - -* `_7_ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) - -* `CEBUANA` (value: `"CEBUANA"`) - -* `ECPAY` (value: `"ECPAY"`) - -* `PALAWAN` (value: `"PALAWAN"`) - -* `MLHUILLIER` (value: `"MLHUILLIER"`) - -* `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) - -* `LBC` (value: `"LBC"`) - -* `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) - -* `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) - -* `CVM` (value: `"CVM"`) - -* `USSC` (value: `"USSC"`) - -* `SM_BILLS` (value: `"SM_BILLS"`) - -* `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) - -* `ALFAMART` (value: `"ALFAMART"`) - -* `INDOMARET` (value: `"INDOMARET"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Over The Counter Channel Code + + ## Enum + + * `_7_ELEVEN` (value: `"7ELEVEN"`) + + * `_7_ELEVEN_CLIQQ` (value: `"7ELEVEN_CLIQQ"`) + + * `CEBUANA` (value: `"CEBUANA"`) + + * `ECPAY` (value: `"ECPAY"`) + + * `PALAWAN` (value: `"PALAWAN"`) + + * `MLHUILLIER` (value: `"MLHUILLIER"`) + + * `ECPAY_DRAGONLOAN` (value: `"ECPAY_DRAGONLOAN"`) + + * `LBC` (value: `"LBC"`) + + * `ECPAY_SCHOOL` (value: `"ECPAY_SCHOOL"`) + + * `RD_PAWNSHOP` (value: `"RD_PAWNSHOP"`) + + * `CVM` (value: `"CVM"`) + + * `USSC` (value: `"USSC"`) + + * `SM_BILLS` (value: `"SM_BILLS"`) + + * `ROBINSONS_BILLS` (value: `"ROBINSONS_BILLS"`) + + * `ALFAMART` (value: `"ALFAMART"`) + + * `INDOMARET` (value: `"INDOMARET"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/OverTheCounterChannelProperties.md b/docs/payment_request/OverTheCounterChannelProperties.md index 5454d548..00d383b4 100644 --- a/docs/payment_request/OverTheCounterChannelProperties.md +++ b/docs/payment_request/OverTheCounterChannelProperties.md @@ -1,12 +1,12 @@ # OverTheCounterChannelProperties +Over The Counter Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **PaymentCode** | Pointer to **string** | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | [optional] | -| **CustomerName** | **string** | Name of customer. | | -| **ExpiresAt** | Pointer to **time.Time** | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **PaymentCode** | Pointer to **string** | | The payment code that you want to assign, e.g 12345. If you do not send one, one will be picked at random. | | +| **CustomerName** | **string** | ☑️ | Name of customer. | | +| **ExpiresAt** | Pointer to **time.Time** | | The time when the payment code will be expired. The minimum is 2 hours and the maximum is 9 days for 7ELEVEN. Default expired date will be 2 days from payment code generated. | | ## Methods diff --git a/docs/payment_request/OverTheCounterParameters.md b/docs/payment_request/OverTheCounterParameters.md index 57cebc24..f8e8c776 100644 --- a/docs/payment_request/OverTheCounterParameters.md +++ b/docs/payment_request/OverTheCounterParameters.md @@ -1,13 +1,13 @@ # OverTheCounterParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | | | -| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **ChannelCode** | [**OverTheCounterChannelCode**](OverTheCounterChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**OverTheCounterChannelProperties**](OverTheCounterChannelProperties.md) | ☑️ | | | ## Methods diff --git a/docs/payment_request/PaymentMethod.md b/docs/payment_request/PaymentMethod.md index 0868c895..575a046f 100644 --- a/docs/payment_request/PaymentMethod.md +++ b/docs/payment_request/PaymentMethod.md @@ -1,24 +1,24 @@ # PaymentMethod -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | | | -| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | | | -| **Created** | Pointer to **string** | | [optional] | -| **Updated** | Pointer to **string** | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Card** | Pointer to [**NullableCard**](Card.md) | | [optional] | -| **DirectDebit** | Pointer to [**NullableDirectDebit**](DirectDebit.md) | | [optional] | -| **Ewallet** | Pointer to [**NullableEWallet**](EWallet.md) | | [optional] | -| **OverTheCounter** | Pointer to [**NullableOverTheCounter**](OverTheCounter.md) | | [optional] | -| **VirtualAccount** | Pointer to [**NullableVirtualAccount**](VirtualAccount.md) | | [optional] | -| **QrCode** | Pointer to [**NullableQRCode**](QRCode.md) | | [optional] | -| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | -| **Status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | | | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | | | +| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | +| **Created** | Pointer to **string** | | | | +| **Updated** | Pointer to **string** | | | | +| **Description** | Pointer to **NullableString** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **Card** | Pointer to [**NullableCard**](Card.md) | | | | +| **DirectDebit** | Pointer to [**NullableDirectDebit**](DirectDebit.md) | | | | +| **Ewallet** | Pointer to [**NullableEWallet**](EWallet.md) | | | | +| **OverTheCounter** | Pointer to [**NullableOverTheCounter**](OverTheCounter.md) | | | | +| **VirtualAccount** | Pointer to [**NullableVirtualAccount**](VirtualAccount.md) | | | | +| **QrCode** | Pointer to [**NullableQRCode**](QRCode.md) | | | | +| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | +| **Status** | [**PaymentMethodStatus**](PaymentMethodStatus.md) | ☑️ | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/payment_request/PaymentMethodParameters.md b/docs/payment_request/PaymentMethodParameters.md index c614d05a..3c1013ae 100644 --- a/docs/payment_request/PaymentMethodParameters.md +++ b/docs/payment_request/PaymentMethodParameters.md @@ -1,18 +1,18 @@ # PaymentMethodParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | | | -| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | | | -| **Description** | Pointer to **NullableString** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **DirectDebit** | Pointer to [**NullableDirectDebitParameters**](DirectDebitParameters.md) | | [optional] | -| **Ewallet** | Pointer to [**NullableEWalletParameters**](EWalletParameters.md) | | [optional] | -| **OverTheCounter** | Pointer to [**NullableOverTheCounterParameters**](OverTheCounterParameters.md) | | [optional] | -| **VirtualAccount** | Pointer to [**NullableVirtualAccountParameters**](VirtualAccountParameters.md) | | [optional] | -| **QrCode** | Pointer to [**NullableQRCodeParameters**](QRCodeParameters.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | [**PaymentMethodType**](PaymentMethodType.md) | ☑️ | | | +| **Reusability** | [**PaymentMethodReusability**](PaymentMethodReusability.md) | ☑️ | | | +| **Description** | Pointer to **NullableString** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **DirectDebit** | Pointer to [**NullableDirectDebitParameters**](DirectDebitParameters.md) | | | | +| **Ewallet** | Pointer to [**NullableEWalletParameters**](EWalletParameters.md) | | | | +| **OverTheCounter** | Pointer to [**NullableOverTheCounterParameters**](OverTheCounterParameters.md) | | | | +| **VirtualAccount** | Pointer to [**NullableVirtualAccountParameters**](VirtualAccountParameters.md) | | | | +| **QrCode** | Pointer to [**NullableQRCodeParameters**](QRCodeParameters.md) | | | | ## Methods diff --git a/docs/payment_request/PaymentMethodReusability.md b/docs/payment_request/PaymentMethodReusability.md index 22157bdb..a68670a1 100644 --- a/docs/payment_request/PaymentMethodReusability.md +++ b/docs/payment_request/PaymentMethodReusability.md @@ -1,13 +1,13 @@ # PaymentMethodReusability -## Enum - -* `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) - -* `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `MULTIPLE_USE` (value: `"MULTIPLE_USE"`) + + * `ONE_TIME_USE` (value: `"ONE_TIME_USE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentMethodStatus.md b/docs/payment_request/PaymentMethodStatus.md index 0c5f91a4..93f9e835 100644 --- a/docs/payment_request/PaymentMethodStatus.md +++ b/docs/payment_request/PaymentMethodStatus.md @@ -1,19 +1,19 @@ # PaymentMethodStatus -## Enum - -* `ACTIVE` (value: `"ACTIVE"`) - -* `INACTIVE` (value: `"INACTIVE"`) - -* `PENDING` (value: `"PENDING"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `FAILED` (value: `"FAILED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `ACTIVE` (value: `"ACTIVE"`) + + * `INACTIVE` (value: `"INACTIVE"`) + + * `PENDING` (value: `"PENDING"`) + + * `EXPIRED` (value: `"EXPIRED"`) + + * `FAILED` (value: `"FAILED"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentMethodType.md b/docs/payment_request/PaymentMethodType.md index cd5b779d..4b18f1b1 100644 --- a/docs/payment_request/PaymentMethodType.md +++ b/docs/payment_request/PaymentMethodType.md @@ -1,21 +1,21 @@ # PaymentMethodType -## Enum - -* `CARD` (value: `"CARD"`) - -* `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) - -* `QR_CODE` (value: `"QR_CODE"`) - -* `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `CARD` (value: `"CARD"`) + + * `DIRECT_DEBIT` (value: `"DIRECT_DEBIT"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OVER_THE_COUNTER` (value: `"OVER_THE_COUNTER"`) + + * `QR_CODE` (value: `"QR_CODE"`) + + * `VIRTUAL_ACCOUNT` (value: `"VIRTUAL_ACCOUNT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentRequest.md b/docs/payment_request/PaymentRequest.md index 6c8571fd..71f21ce8 100644 --- a/docs/payment_request/PaymentRequest.md +++ b/docs/payment_request/PaymentRequest.md @@ -1,32 +1,32 @@ # PaymentRequest -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | | | -| **Created** | **string** | | | -| **Updated** | **string** | | | -| **ReferenceId** | **string** | | | -| **BusinessId** | **string** | | | -| **CustomerId** | Pointer to **NullableString** | | [optional] | -| **Customer** | Pointer to **map[string]interface{}** | | [optional] | -| **Amount** | Pointer to **float64** | | [optional] | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Country** | Pointer to [**PaymentRequestCountry**](PaymentRequestCountry.md) | | [optional] | -| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **PaymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | | -| **Description** | Pointer to **NullableString** | | [optional] | -| **FailureCode** | Pointer to **NullableString** | | [optional] | -| **CaptureMethod** | Pointer to [**NullablePaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | [optional] | -| **Initiator** | Pointer to [**NullablePaymentRequestInitiator**](PaymentRequestInitiator.md) | | [optional] | -| **CardVerificationResults** | Pointer to [**NullablePaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | [optional] | -| **Status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | | | -| **Actions** | Pointer to [**PaymentRequestAction[]**](PaymentRequestAction.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | -| **ShippingInformation** | Pointer to [**NullablePaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | [optional] | -| **Items** | Pointer to [**PaymentRequestBasketItem[]**](PaymentRequestBasketItem.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | | | +| **Created** | **string** | ☑️ | | | +| **Updated** | **string** | ☑️ | | | +| **ReferenceId** | **string** | ☑️ | | | +| **BusinessId** | **string** | ☑️ | | | +| **CustomerId** | Pointer to **NullableString** | | | | +| **Customer** | Pointer to **map[string]interface{}** | | | | +| **Amount** | Pointer to **float64** | | | | +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **Country** | Pointer to [**PaymentRequestCountry**](PaymentRequestCountry.md) | | | | +| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | +| **PaymentMethod** | [**PaymentMethod**](PaymentMethod.md) | ☑️ | | | +| **Description** | Pointer to **NullableString** | | | | +| **FailureCode** | Pointer to **NullableString** | | | | +| **CaptureMethod** | Pointer to [**NullablePaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | +| **Initiator** | Pointer to [**NullablePaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | +| **CardVerificationResults** | Pointer to [**NullablePaymentRequestCardVerificationResults**](PaymentRequestCardVerificationResults.md) | | | | +| **Status** | [**PaymentRequestStatus**](PaymentRequestStatus.md) | ☑️ | | | +| **Actions** | Pointer to [**PaymentRequestAction[]**](PaymentRequestAction.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | +| **ShippingInformation** | Pointer to [**NullablePaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | +| **Items** | Pointer to [**PaymentRequestBasketItem[]**](PaymentRequestBasketItem.md) | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestAction.md b/docs/payment_request/PaymentRequestAction.md index 67fe1ab5..0e8ade44 100644 --- a/docs/payment_request/PaymentRequestAction.md +++ b/docs/payment_request/PaymentRequestAction.md @@ -1,14 +1,14 @@ # PaymentRequestAction -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Action** | **string** | | | -| **UrlType** | **string** | | | -| **Method** | **NullableString** | | | -| **Url** | **NullableString** | | | -| **QrCode** | **NullableString** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Action** | **string** | ☑️ | | | +| **UrlType** | **string** | ☑️ | | | +| **Method** | **NullableString** | ☑️ | | | +| **Url** | **NullableString** | ☑️ | | | +| **QrCode** | **NullableString** | ☑️ | | | ## Methods diff --git a/docs/payment_request/PaymentRequestAuthParameters.md b/docs/payment_request/PaymentRequestAuthParameters.md index 9ffb5e8d..510b7161 100644 --- a/docs/payment_request/PaymentRequestAuthParameters.md +++ b/docs/payment_request/PaymentRequestAuthParameters.md @@ -1,10 +1,10 @@ # PaymentRequestAuthParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AuthCode** | **string** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AuthCode** | **string** | ☑️ | | | ## Methods diff --git a/docs/payment_request/PaymentRequestBasketItem.md b/docs/payment_request/PaymentRequestBasketItem.md index edc07e83..2fe8408c 100644 --- a/docs/payment_request/PaymentRequestBasketItem.md +++ b/docs/payment_request/PaymentRequestBasketItem.md @@ -1,22 +1,22 @@ # PaymentRequestBasketItem -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Name** | **string** | | | -| **Description** | Pointer to **string** | | [optional] | -| **Type** | Pointer to **string** | | [optional] | -| **Category** | **string** | | | -| **SubCategory** | Pointer to **string** | | [optional] | -| **Currency** | **string** | | | -| **Quantity** | **float64** | | | -| **Price** | **float64** | | | -| **PayerChargedCurrency** | Pointer to **string** | | [optional] | -| **PayerChargedPrice** | Pointer to **float64** | | [optional] | -| **Url** | Pointer to **string** | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | Pointer to **string** | | | | +| **Name** | **string** | ☑️ | | | +| **Description** | Pointer to **string** | | | | +| **Type** | Pointer to **string** | | | | +| **Category** | **string** | ☑️ | | | +| **SubCategory** | Pointer to **string** | | | | +| **Currency** | **string** | ☑️ | | | +| **Quantity** | **float64** | ☑️ | | | +| **Price** | **float64** | ☑️ | | | +| **PayerChargedCurrency** | Pointer to **string** | | | | +| **PayerChargedPrice** | Pointer to **float64** | | | | +| **Url** | Pointer to **string** | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestCaptureMethod.md b/docs/payment_request/PaymentRequestCaptureMethod.md index 1c28b0d3..3deb69fe 100644 --- a/docs/payment_request/PaymentRequestCaptureMethod.md +++ b/docs/payment_request/PaymentRequestCaptureMethod.md @@ -1,13 +1,13 @@ # PaymentRequestCaptureMethod -## Enum - -* `AUTOMATIC` (value: `"AUTOMATIC"`) - -* `MANUAL` (value: `"MANUAL"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `AUTOMATIC` (value: `"AUTOMATIC"`) + + * `MANUAL` (value: `"MANUAL"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentRequestCardVerificationResults.md b/docs/payment_request/PaymentRequestCardVerificationResults.md index f481adc5..3e978e4a 100644 --- a/docs/payment_request/PaymentRequestCardVerificationResults.md +++ b/docs/payment_request/PaymentRequestCardVerificationResults.md @@ -1,12 +1,12 @@ # PaymentRequestCardVerificationResults -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecure** | [**NullablePaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | | | -| **CvvResult** | Pointer to **NullableString** | | [optional] | -| **AddressVerificationResult** | Pointer to **NullableString** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecure** | [**NullablePaymentRequestCardVerificationResultsThreeDeeSecure**](PaymentRequestCardVerificationResultsThreeDeeSecure.md) | ☑️ | | | +| **CvvResult** | Pointer to **NullableString** | | | | +| **AddressVerificationResult** | Pointer to **NullableString** | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md b/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md index c5204414..10ecb71c 100644 --- a/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md +++ b/docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md @@ -1,14 +1,14 @@ # PaymentRequestCardVerificationResultsThreeDeeSecure -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ThreeDSecureFlow** | Pointer to **string** | | [optional] | -| **EciCode** | Pointer to **string** | | [optional] | -| **ThreeDSecureResult** | Pointer to **string** | | [optional] | -| **ThreeDSecureResultReason** | Pointer to **NullableString** | | [optional] | -| **ThreeDSecureVersion** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ThreeDSecureFlow** | Pointer to **string** | | | | +| **EciCode** | Pointer to **string** | | | | +| **ThreeDSecureResult** | Pointer to **string** | | | | +| **ThreeDSecureResultReason** | Pointer to **NullableString** | | | | +| **ThreeDSecureVersion** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestChannelProperties.md b/docs/payment_request/PaymentRequestChannelProperties.md index 07ca6f97..dc5e426c 100644 --- a/docs/payment_request/PaymentRequestChannelProperties.md +++ b/docs/payment_request/PaymentRequestChannelProperties.md @@ -1,16 +1,16 @@ # PaymentRequestChannelProperties -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CancelReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **RedeemPoints** | Pointer to **string** | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | [optional] | -| **RequireAuth** | Pointer to **bool** | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | [optional] | -| **MerchantIdTag** | Pointer to **string** | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | [optional] | -| **CardonfileType** | Pointer to **NullableString** | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization failed | | +| **CancelReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization cancelled | | +| **RedeemPoints** | Pointer to **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | +| **RequireAuth** | Pointer to **bool** | | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | | +| **MerchantIdTag** | Pointer to **string** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | +| **CardonfileType** | Pointer to **NullableString** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | ## Methods diff --git a/docs/payment_request/PaymentRequestCountry.md b/docs/payment_request/PaymentRequestCountry.md index 16748792..031375aa 100644 --- a/docs/payment_request/PaymentRequestCountry.md +++ b/docs/payment_request/PaymentRequestCountry.md @@ -1,19 +1,19 @@ # PaymentRequestCountry -## Enum - -* `ID` (value: `"ID"`) - -* `PH` (value: `"PH"`) - -* `VN` (value: `"VN"`) - -* `TH` (value: `"TH"`) - -* `MY` (value: `"MY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `ID` (value: `"ID"`) + + * `PH` (value: `"PH"`) + + * `VN` (value: `"VN"`) + + * `TH` (value: `"TH"`) + + * `MY` (value: `"MY"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentRequestCurrency.md b/docs/payment_request/PaymentRequestCurrency.md index 5b7f146d..9da9de18 100644 --- a/docs/payment_request/PaymentRequestCurrency.md +++ b/docs/payment_request/PaymentRequestCurrency.md @@ -1,19 +1,21 @@ # PaymentRequestCurrency -## Enum - -* `IDR` (value: `"IDR"`) - -* `PHP` (value: `"PHP"`) - -* `VND` (value: `"VND"`) - -* `THB` (value: `"THB"`) - -* `MYR` (value: `"MYR"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `IDR` (value: `"IDR"`) + + * `PHP` (value: `"PHP"`) + + * `VND` (value: `"VND"`) + + * `THB` (value: `"THB"`) + + * `MYR` (value: `"MYR"`) + + * `USD` (value: `"USD"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentRequestInitiator.md b/docs/payment_request/PaymentRequestInitiator.md index 9aea5e47..eac7772e 100644 --- a/docs/payment_request/PaymentRequestInitiator.md +++ b/docs/payment_request/PaymentRequestInitiator.md @@ -1,13 +1,13 @@ # PaymentRequestInitiator -## Enum - -* `CUSTOMER` (value: `"CUSTOMER"`) - -* `MERCHANT` (value: `"MERCHANT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `CUSTOMER` (value: `"CUSTOMER"`) + + * `MERCHANT` (value: `"MERCHANT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/PaymentRequestListResponse.md b/docs/payment_request/PaymentRequestListResponse.md index 648bfd2e..4e499b9f 100644 --- a/docs/payment_request/PaymentRequestListResponse.md +++ b/docs/payment_request/PaymentRequestListResponse.md @@ -1,11 +1,11 @@ # PaymentRequestListResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Data** | [**PaymentRequest[]**](PaymentRequest.md) | | | -| **HasMore** | **bool** | | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Data** | [**PaymentRequest[]**](PaymentRequest.md) | ☑️ | | | +| **HasMore** | **bool** | ☑️ | | | ## Methods diff --git a/docs/payment_request/PaymentRequestParameters.md b/docs/payment_request/PaymentRequestParameters.md index bc3ee80d..e5bbea59 100644 --- a/docs/payment_request/PaymentRequestParameters.md +++ b/docs/payment_request/PaymentRequestParameters.md @@ -1,23 +1,23 @@ # PaymentRequestParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Amount** | Pointer to **float64** | | [optional] | -| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | -| **PaymentMethod** | Pointer to [**PaymentMethodParameters**](PaymentMethodParameters.md) | | [optional] | -| **Description** | Pointer to **NullableString** | | [optional] | -| **CaptureMethod** | Pointer to [**NullablePaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | [optional] | -| **Initiator** | Pointer to [**NullablePaymentRequestInitiator**](PaymentRequestInitiator.md) | | [optional] | -| **PaymentMethodId** | Pointer to **string** | | [optional] | -| **ChannelProperties** | Pointer to [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | [optional] | -| **ShippingInformation** | Pointer to [**NullablePaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | [optional] | -| **Items** | Pointer to [**PaymentRequestBasketItem[]**](PaymentRequestBasketItem.md) | | [optional] | -| **CustomerId** | Pointer to **NullableString** | | [optional] | -| **Customer** | Pointer to **map[string]interface{}** | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | Pointer to **string** | | | | +| **Amount** | Pointer to **float64** | | | | +| **Currency** | [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | ☑️ | | | +| **PaymentMethod** | Pointer to [**PaymentMethodParameters**](PaymentMethodParameters.md) | | | | +| **Description** | Pointer to **NullableString** | | | | +| **CaptureMethod** | Pointer to [**NullablePaymentRequestCaptureMethod**](PaymentRequestCaptureMethod.md) | | | | +| **Initiator** | Pointer to [**NullablePaymentRequestInitiator**](PaymentRequestInitiator.md) | | | | +| **PaymentMethodId** | Pointer to **string** | | | | +| **ChannelProperties** | Pointer to [**PaymentRequestParametersChannelProperties**](PaymentRequestParametersChannelProperties.md) | | | | +| **ShippingInformation** | Pointer to [**NullablePaymentRequestShippingInformation**](PaymentRequestShippingInformation.md) | | | | +| **Items** | Pointer to [**PaymentRequestBasketItem[]**](PaymentRequestBasketItem.md) | | | | +| **CustomerId** | Pointer to **NullableString** | | | | +| **Customer** | Pointer to **map[string]interface{}** | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestParametersChannelProperties.md b/docs/payment_request/PaymentRequestParametersChannelProperties.md index 767a0779..ef51f32a 100644 --- a/docs/payment_request/PaymentRequestParametersChannelProperties.md +++ b/docs/payment_request/PaymentRequestParametersChannelProperties.md @@ -1,17 +1,17 @@ # PaymentRequestParametersChannelProperties -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **SuccessReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization is successful | [optional] | -| **FailureReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization failed | [optional] | -| **CancelReturnUrl** | Pointer to **string** | URL where the end-customer is redirected if the authorization cancelled | [optional] | -| **RedeemPoints** | Pointer to **string** | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | [optional] | -| **RequireAuth** | Pointer to **bool** | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | [optional] | -| **MerchantIdTag** | Pointer to **string** | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | [optional] | -| **CardonfileType** | Pointer to **NullableString** | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | [optional] | -| **Cvv** | Pointer to **string** | Three digit code written on the back of the card (usually called CVV/CVN). | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **SuccessReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization is successful | | +| **FailureReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization failed | | +| **CancelReturnUrl** | Pointer to **string** | | URL where the end-customer is redirected if the authorization cancelled | | +| **RedeemPoints** | Pointer to **string** | | REDEEM_NONE will not use any point, REDEEM_ALL will use all available points before cash balance is used. For OVO and ShopeePay tokenized payment use only. | | +| **RequireAuth** | Pointer to **bool** | | Toggle used to require end-customer to input undergo OTP validation before completing a payment. OTP will always be required for transactions greater than 1,000,000 IDR. For BRI tokenized payment use only. | | +| **MerchantIdTag** | Pointer to **string** | | Tag for a Merchant ID that you want to associate this payment with. For merchants using their own MIDs to specify which MID they want to use | | +| **CardonfileType** | Pointer to **NullableString** | | Type of “credential-on-file” / “card-on-file” payment being made. Indicate that this payment uses a previously linked Payment Method for charging. | | +| **Cvv** | Pointer to **string** | | Three digit code written on the back of the card (usually called CVV/CVN). | | ## Methods diff --git a/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md b/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md index 3b11a35e..13cd429e 100644 --- a/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md +++ b/docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md @@ -1,10 +1,10 @@ # PaymentRequestParametersChannelPropertiesAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Cvv** | Pointer to **string** | Three digit code written on the back of the card (usually called CVV/CVN). | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Cvv** | Pointer to **string** | | Three digit code written on the back of the card (usually called CVV/CVN). | | ## Methods diff --git a/docs/payment_request/PaymentRequestShippingInformation.md b/docs/payment_request/PaymentRequestShippingInformation.md index 3f1939b4..5e721029 100644 --- a/docs/payment_request/PaymentRequestShippingInformation.md +++ b/docs/payment_request/PaymentRequestShippingInformation.md @@ -1,15 +1,15 @@ # PaymentRequestShippingInformation -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Country** | **string** | | | -| **StreetLine1** | Pointer to **string** | | [optional] | -| **StreetLine2** | Pointer to **string** | | [optional] | -| **City** | Pointer to **string** | | [optional] | -| **ProvinceState** | Pointer to **string** | | [optional] | -| **PostalCode** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Country** | **string** | ☑️ | | | +| **StreetLine1** | Pointer to **string** | | | | +| **StreetLine2** | Pointer to **string** | | | | +| **City** | Pointer to **string** | | | | +| **ProvinceState** | Pointer to **string** | | | | +| **PostalCode** | Pointer to **string** | | | | ## Methods diff --git a/docs/payment_request/PaymentRequestStatus.md b/docs/payment_request/PaymentRequestStatus.md index d19501f7..4a3e5890 100644 --- a/docs/payment_request/PaymentRequestStatus.md +++ b/docs/payment_request/PaymentRequestStatus.md @@ -1,25 +1,25 @@ # PaymentRequestStatus -## Enum - -* `PENDING` (value: `"PENDING"`) - -* `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) - -* `CANCELED` (value: `"CANCELED"`) - -* `SUCCEEDED` (value: `"SUCCEEDED"`) - -* `FAILED` (value: `"FAILED"`) - -* `VOIDED` (value: `"VOIDED"`) - -* `UNKNOWN` (value: `"UNKNOWN"`) - -* `AWAITING_CAPTURE` (value: `"AWAITING_CAPTURE"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) + ## Enum + + * `PENDING` (value: `"PENDING"`) + + * `REQUIRES_ACTION` (value: `"REQUIRES_ACTION"`) + + * `CANCELED` (value: `"CANCELED"`) + + * `SUCCEEDED` (value: `"SUCCEEDED"`) + + * `FAILED` (value: `"FAILED"`) + + * `VOIDED` (value: `"VOIDED"`) + + * `UNKNOWN` (value: `"UNKNOWN"`) + + * `AWAITING_CAPTURE` (value: `"AWAITING_CAPTURE"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/QRCode.md b/docs/payment_request/QRCode.md index ed174da3..fb2b3405 100644 --- a/docs/payment_request/QRCode.md +++ b/docs/payment_request/QRCode.md @@ -1,11 +1,11 @@ # QRCode +QRCode Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | ## Methods diff --git a/docs/payment_request/QRCodeChannelCode.md b/docs/payment_request/QRCodeChannelCode.md index 750efa77..2e89e061 100644 --- a/docs/payment_request/QRCodeChannelCode.md +++ b/docs/payment_request/QRCodeChannelCode.md @@ -1,17 +1,17 @@ # QRCodeChannelCode - -## Enum - - -* `DANA` (value: `"DANA"`) - -* `RCBC` (value: `"RCBC"`) - -* `LINKAJA` (value: `"LINKAJA"`) - -* `PROMPTPAY` (value: `"PROMPTPAY"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +QR Code Channel Code + + ## Enum + + * `DANA` (value: `"DANA"`) + + * `RCBC` (value: `"RCBC"`) + + * `LINKAJA` (value: `"LINKAJA"`) + + * `PROMPTPAY` (value: `"PROMPTPAY"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/QRCodeChannelProperties.md b/docs/payment_request/QRCodeChannelProperties.md index 42ab882a..6e98ba48 100644 --- a/docs/payment_request/QRCodeChannelProperties.md +++ b/docs/payment_request/QRCodeChannelProperties.md @@ -1,11 +1,11 @@ # QRCodeChannelProperties +QR Code Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **QrString** | Pointer to **string** | | [optional] | -| **ExpiresAt** | Pointer to **time.Time** | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **QrString** | Pointer to **string** | | | | +| **ExpiresAt** | Pointer to **time.Time** | | | | ## Methods diff --git a/docs/payment_request/QRCodeParameters.md b/docs/payment_request/QRCodeParameters.md index fc485af0..85684d15 100644 --- a/docs/payment_request/QRCodeParameters.md +++ b/docs/payment_request/QRCodeParameters.md @@ -1,11 +1,11 @@ # QRCodeParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | [optional] | -| **ChannelProperties** | Pointer to [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | Pointer to [**NullableQRCodeChannelCode**](QRCodeChannelCode.md) | | | | +| **ChannelProperties** | Pointer to [**QRCodeChannelProperties**](QRCodeChannelProperties.md) | | | | ## Methods diff --git a/docs/payment_request/VirtualAccount.md b/docs/payment_request/VirtualAccount.md index d725fab4..affffa3e 100644 --- a/docs/payment_request/VirtualAccount.md +++ b/docs/payment_request/VirtualAccount.md @@ -1,17 +1,17 @@ # VirtualAccount +Virtual Account Payment Method Details ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **AlternativeDisplayTypes** | Pointer to **string[]** | Alternative display requested for the virtual account | [optional] | -| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | +| **AlternativeDisplayTypes** | Pointer to **string[]** | | Alternative display requested for the virtual account | | +| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | | | ## Methods diff --git a/docs/payment_request/VirtualAccountAllOf.md b/docs/payment_request/VirtualAccountAllOf.md index 792f9b9a..0a418b8e 100644 --- a/docs/payment_request/VirtualAccountAllOf.md +++ b/docs/payment_request/VirtualAccountAllOf.md @@ -1,10 +1,10 @@ # VirtualAccountAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AlternativeDisplays** | Pointer to [**VirtualAccountAlternativeDisplay[]**](VirtualAccountAlternativeDisplay.md) | | | | ## Methods diff --git a/docs/payment_request/VirtualAccountAlternativeDisplay.md b/docs/payment_request/VirtualAccountAlternativeDisplay.md index df5b2e6c..48de451a 100644 --- a/docs/payment_request/VirtualAccountAlternativeDisplay.md +++ b/docs/payment_request/VirtualAccountAlternativeDisplay.md @@ -1,11 +1,11 @@ # VirtualAccountAlternativeDisplay +Alternative Display Object ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Type** | Pointer to **string** | Type of the alternative display | [optional] [readonly] | -| **Data** | Pointer to **string** | Data payload of the given alternative display | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Type** | Pointer to **string** | | Type of the alternative display | | +| **Data** | Pointer to **string** | | Data payload of the given alternative display | | ## Methods diff --git a/docs/payment_request/VirtualAccountChannelCode.md b/docs/payment_request/VirtualAccountChannelCode.md index 2a89dc13..c5b806bf 100644 --- a/docs/payment_request/VirtualAccountChannelCode.md +++ b/docs/payment_request/VirtualAccountChannelCode.md @@ -1,39 +1,41 @@ # VirtualAccountChannelCode - -## Enum - - -* `BCA` (value: `"BCA"`) - -* `BJB` (value: `"BJB"`) - -* `BNI` (value: `"BNI"`) - -* `BRI` (value: `"BRI"`) - -* `MANDIRI` (value: `"MANDIRI"`) - -* `PERMATA` (value: `"PERMATA"`) - -* `BSI` (value: `"BSI"`) - -* `CIMB` (value: `"CIMB"`) - -* `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) - -* `ARTAJASA` (value: `"ARTAJASA"`) - -* `PV` (value: `"PV"`) - -* `VIETCAPITAL` (value: `"VIETCAPITAL"`) - -* `WOORI` (value: `"WOORI"`) - -* `MSB` (value: `"MSB"`) - -* `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Virtual Account Channel Code + + ## Enum + + * `BCA` (value: `"BCA"`) + + * `BJB` (value: `"BJB"`) + + * `BNI` (value: `"BNI"`) + + * `BRI` (value: `"BRI"`) + + * `MANDIRI` (value: `"MANDIRI"`) + + * `PERMATA` (value: `"PERMATA"`) + + * `BSI` (value: `"BSI"`) + + * `CIMB` (value: `"CIMB"`) + + * `SAHABAT_SAMPOERNA` (value: `"SAHABAT_SAMPOERNA"`) + + * `ARTAJASA` (value: `"ARTAJASA"`) + + * `PV` (value: `"PV"`) + + * `VIETCAPITAL` (value: `"VIETCAPITAL"`) + + * `WOORI` (value: `"WOORI"`) + + * `MSB` (value: `"MSB"`) + + * `STANDARD_CHARTERED` (value: `"STANDARD_CHARTERED"`) + + * `AMBANK` (value: `"AMBANK"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payment_request/VirtualAccountChannelProperties.md b/docs/payment_request/VirtualAccountChannelProperties.md index 4a5ce59a..21f392da 100644 --- a/docs/payment_request/VirtualAccountChannelProperties.md +++ b/docs/payment_request/VirtualAccountChannelProperties.md @@ -1,13 +1,13 @@ # VirtualAccountChannelProperties +Virtual Account Channel Properties ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **CustomerName** | **string** | Name of customer. | | -| **VirtualAccountNumber** | Pointer to **string** | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | [optional] | -| **ExpiresAt** | Pointer to **time.Time** | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | [optional] | -| **SuggestedAmount** | Pointer to **float64** | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **CustomerName** | **string** | ☑️ | Name of customer. | | +| **VirtualAccountNumber** | Pointer to **string** | | You can assign specific Virtual Account number using this parameter. If you do not send one, one will be picked at random. Make sure the number you specify is within your Virtual Account range. | | +| **ExpiresAt** | Pointer to **time.Time** | | The date and time in ISO 8601 UTC+0 when the virtual account number will be expired. Default: The default expiration date will be 31 years from creation date. | | +| **SuggestedAmount** | Pointer to **float64** | | The suggested amount you want to assign. Note: Suggested amounts is the amounts that can see as a suggestion, but user can still put any numbers (only supported for Mandiri and BRI) | | ## Methods diff --git a/docs/payment_request/VirtualAccountParameters.md b/docs/payment_request/VirtualAccountParameters.md index 06aa8367..5a390271 100644 --- a/docs/payment_request/VirtualAccountParameters.md +++ b/docs/payment_request/VirtualAccountParameters.md @@ -1,16 +1,16 @@ # VirtualAccountParameters -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **MinAmount** | Pointer to **NullableFloat64** | | [optional] | -| **MaxAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Amount** | Pointer to **NullableFloat64** | | [optional] | -| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | [optional] | -| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | | | -| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | | | -| **AlternativeDisplayTypes** | Pointer to **string[]** | Alternative display requested for the virtual account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **MinAmount** | Pointer to **NullableFloat64** | | | | +| **MaxAmount** | Pointer to **NullableFloat64** | | | | +| **Amount** | Pointer to **NullableFloat64** | | | | +| **Currency** | Pointer to [**PaymentRequestCurrency**](PaymentRequestCurrency.md) | | | | +| **ChannelCode** | [**VirtualAccountChannelCode**](VirtualAccountChannelCode.md) | ☑️ | | | +| **ChannelProperties** | [**VirtualAccountChannelProperties**](VirtualAccountChannelProperties.md) | ☑️ | | | +| **AlternativeDisplayTypes** | Pointer to **string[]** | | Alternative display requested for the virtual account | | ## Methods diff --git a/docs/payout.yaml b/docs/payout.yaml deleted file mode 100644 index 1263c1b8..00000000 --- a/docs/payout.yaml +++ /dev/null @@ -1,894 +0,0 @@ -openapi: 3.0.0 -info: - contact: - email: help@xendit.co - description: "This API allows Xendit to send money from an account to a channel\ - \ (banks, eWallets, retail outlets) from across regions" - license: - name: UNLICENSED - url: https://xendit.co/en/terms-and-conditions/ - termsOfService: https://xendit.co/en/terms-and-conditions/ - title: Payout Service - version: 1.0.0 -externalDocs: - description: Find out more - url: https://developers.xendit.co/api-reference/#payouts -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /v2/payouts: - get: - operationId: getPayouts - parameters: - - description: Reference_id provided when creating the payout - explode: true - in: query - name: reference_id - required: true - schema: - example: DISB-123 - type: string - style: form - - description: Number of records to fetch per API call - explode: true - in: query - name: limit - required: false - schema: - example: 10 - type: number - style: form - - description: Used to fetch record after this payout unique id - explode: true - in: query - name: after_id - required: false - schema: - example: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - type: string - style: form - - description: Used to fetch record before this payout unique id - explode: true - in: query - name: before_id - required: false - schema: - example: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - type: string - style: form - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - examples: - With matching payouts: - value: - data: - - id: disb-5594002a-d0a0-4cd9-b3f7-f5992abc8e48 - reference_id: DISB-001 - channel_code: PH_BDO - channel_properties: - account_holder_name: John Doe - account_number: "000000" - description: FX1234 - currency: PHP - amount: 15000.05 - receipt_notification: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - email_bcc: - - user_bcc@example.com - metadata: - external_party: xendit - created: 2019-11-01T12:34:56.007Z - updated: 2019-11-01T12:34:56.007Z - business_id: 5dbf20d7c8eb0c0896f811b6 - status: ACCEPTED - estimated_arrival_time: 2019-11-01T12:34:56.007Z - has_more: false - schema: - $ref: '#/components/schemas/getPayouts_200_response' - description: An array of Payout objects sorted by created time in desc order. - "data" will be an empty array and "has_more' will be equal to false when - there are no matching data. - "403": - content: - application/json: - example: - error_code: REQUEST_FORBIDDEN_ERROR - message: The API key is forbidden to perform this request. - schema: - $ref: '#/components/schemas/Error' - description: API key in use does not have necessary permissions to perform - the request. Please assign proper permissions for the key. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: API to retrieve all matching payouts with reference ID - tags: - - payout - post: - operationId: createPayout - parameters: - - description: A unique key to prevent duplicate requests from pushing through - our system. No expiration. - explode: false - in: header - name: idempotency-key - required: true - schema: - example: DISB-1234 - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - examples: - Bank or EWallet Payout: - value: - reference_id: DISB-001 - currency: PHP - channel_code: PH_BDO - channel_properties: - account_holder_name: John Doe - account_number: "000000" - amount: 90000 - description: Test Bank Payout - type: DIRECT_DISBURSEMENT - schema: - $ref: '#/components/schemas/CreatePayoutRequest' - responses: - "200": - content: - application/json: - examples: - Successfully created payout: - value: - id: disb-5594002a-d0a0-4cd9-b3f7-f5992abc8e48 - reference_id: DISB-001 - channel_code: PH_BDO - channel_properties: - account_holder_name: John Doe - account_number: "000000" - description: FX1234 - currency: PHP - amount: 15000.05 - receipt_notification: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - email_bcc: - - user_bcc@example.com - metadata: - external_party: xendit - created: 2019-11-01T12:34:56.007Z - updated: 2019-11-01T12:34:56.007Z - business_id: 5dbf20d7c8eb0c0896f811b6 - status: ACCEPTED - estimated_arrival_time: 2019-11-01T12:34:56.007Z - schema: - $ref: '#/components/schemas/getPayouts_200_response_data_inner' - description: Created payout - "400": - content: - application/json: - examples: - Missing parameters or invalid headers: - value: - error_code: API_VALIDATION_ERROR - message: Should have required property "xxx" - Amount has more than 2 decimal places: - value: - error_code: API_VALIDATION_ERROR - message: '"amount" should have 2 decimal places or less' - Channel code not supported yet: - value: - error_code: CHANNEL_CODE_NOT_SUPPORTED - message: “channel_code” is not supported. See list of supported - channel codes at /payouts_channels. - Minimum transfer limit error per channel: - value: - error_code: MINIMUM_TRANSFER_LIMIT_ERROR - message: “amount” is under the minimum amount supported for the - channel. See amount limitations at the URL below. - Maximum transfer limit error per channel: - value: - error_code: MAXIMUM_TRANSFER_LIMIT_ERROR - message: “amount” is more than the maximum amount supported for - the channel. See amount limitations at the URL below. - Amount Increment Not Supported: - value: - error_code: AMOUNT_INCREMENT_NOT_SUPPORTED - message: amount” needs to be a multiple of the minimum increment - supported by the channel. - schema: - $ref: '#/components/schemas/Error' - description: "Error when creating payout, see error_code for more details" - "401": - content: - application/json: - example: - error_code: INVALID_API_KEY - message: API key format is invalid. - schema: - $ref: '#/components/schemas/Error' - description: Invalid API key - "403": - content: - application/json: - example: - error_code: REQUEST_FORBIDDEN_ERROR - message: The API key is forbidden to perform this request. - schema: - $ref: '#/components/schemas/Error' - description: API key in use does not have necessary permissions to perform - the request. Please assign proper permissions for the key. - "409": - content: - application/json: - example: - error_code: DUPLICATE_ERROR - message: "A payout with this idempotency key already exists. If you\ - \ meant to execute a different request, please use another idempotency\ - \ key." - schema: - $ref: '#/components/schemas/Error' - description: "Duplicate Error, payout already exists" - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: API to send money at scale to bank accounts & eWallets - tags: - - payout - /v2/payouts/{id}: - get: - operationId: getPayoutById - parameters: - - description: Payout id returned from the response of /v2/payouts - explode: false - in: path - name: id - required: true - schema: - example: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - examples: - With matching payout: - value: - id: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - reference_id: DISB-001 - channel_code: PH_BDO - channel_properties: - account_holder_name: John Doe - account_number: "000000" - description: FX1234 - currency: PHP - amount: 15000.05 - receipt_notification: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - email_bcc: - - user_bcc@example.com - metadata: - external_party: xendit - created: 2019-11-01T12:34:56.007Z - updated: 2019-11-01T12:34:56.007Z - business_id: 5dbf20d7c8eb0c0896f811b6 - status: ACCEPTED - estimated_arrival_time: 2019-11-01T12:34:56.007Z - schema: - $ref: '#/components/schemas/getPayouts_200_response_data_inner' - description: The Payout object - "401": - content: - application/json: - example: - error_code: INVALID_API_KEY - message: API key format is invalid. - schema: - $ref: '#/components/schemas/Error' - description: Invalid API key - "403": - content: - application/json: - example: - error_code: REQUEST_FORBIDDEN_ERROR - message: The API key is forbidden to perform this request. - schema: - $ref: '#/components/schemas/Error' - description: API key in use does not have necessary permissions to perform - the request. Please assign proper permissions for the key. - "404": - content: - application/json: - example: - error_code: DATA_NOT_FOUND - message: Could not find payout with the corresponding ID. Please try - again with a valid ID. - schema: - $ref: '#/components/schemas/Error' - description: Payout Not Found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: "API to fetch the current status, or details of the payout" - tags: - - payout - /payouts_channels: - get: - operationId: getPayoutChannels - parameters: - - description: Filter channels by currency from ISO-4217 values - explode: true - in: query - name: currency - required: false - schema: - example: "IDR, PHP" - type: string - style: form - - allowReserved: true - description: Filter channels by category - explode: false - in: query - name: channel_category - required: false - schema: - items: - $ref: '#/components/schemas/ChannelCategory' - type: array - style: form - - description: "Filter channels by channel code, prefixed by ISO-3166 country\ - \ code" - explode: true - in: query - name: channel_code - required: false - schema: - example: "ID_MANDIRI, PH_GCASH" - type: string - style: form - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - example: - - channel_code: ID_MANDIRI - channel_category: BANK - currency: IDR - name: Bank Mandiri - amount_limits: - minimum: "1," - maximum: "5000000," - minimum_increment: 1 - - channel_code: PH_GCASH - channel_category: BANK - currency: PHP - name: GCASH - amount_limits: - minimum: "1," - maximum: "50000," - minimum_increment: 0.01 - items: - $ref: '#/components/schemas/Channel' - type: array - description: Current list of banks and e-wallets supported for payouts for - all regions - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: API providing the current list of banks and e-wallets we support for - payouts for both regions - tags: - - payout - /v2/payouts/{id}/cancel: - post: - operationId: cancelPayout - parameters: - - description: Payout id returned from the response of /v2/payouts - explode: false - in: path - name: id - required: true - schema: - example: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - type: string - style: simple - - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - examples: - For API Gateway: - value: - id: disb-7baa7335-a0b2-4678-bb8c-318c0167f332 - reference_id: DISB-001 - channel_code: PH_BDO - channel_properties: - account_holder_name: John Doe - account_number: "000000" - description: FX1234 - currency: PHP - amount: 15000.05 - receipt_notification: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - email_bcc: - - user_bcc@example.com - metadata: - external_party: xendit - created: 2019-11-01T12:34:56.007Z - updated: 2019-11-01T12:34:56.007Z - business_id: 5dbf20d7c8eb0c0896f811b6 - status: CANCELLED - schema: - $ref: '#/components/schemas/getPayouts_200_response_data_inner' - description: Cancelled Successfully - "400": - content: - application/json: - example: - error_code: CANCELLATION_NOT_ALLOWED - message: Payout cannot be canceled because it has already been processed - by Xendit. - schema: - $ref: '#/components/schemas/Error' - description: Unable to Cancel - "404": - content: - application/json: - example: - error_code: DATA_NOT_FOUND - message: Could not find payout with the corresponding ID. Please try - again with a valid ID - schema: - $ref: '#/components/schemas/Error' - description: Invalid Payout ID - default: - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Errors - summary: API to cancel requested payouts that have not yet been sent to partner - banks and e-wallets. Cancellation is possible if the payout has not been sent - out via our partner and when payout status is ACCEPTED. - tags: - - payout -components: - parameters: - ForUserIdHeader: - description: The sub-account user-id that you want to make this transaction - for. This header is only used if you have access to xenPlatform. See xenPlatform - for more information. - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - schemas: - ReceiptNotification: - description: Additional notification for completed payout - example: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_bcc: - - user_bcc@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - properties: - email_to: - description: Valid email address to send the payout receipt - example: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - items: - format: email - maxItems: 3 - type: string - nullable: true - type: array - email_cc: - description: Valid email address to cc the payout receipt - example: - - user_cc@example.com - - user_cc2@example.com - items: - format: email - maxItems: 3 - type: string - nullable: true - type: array - email_bcc: - description: Valid email address to bcc the payout receipt - example: - - user_bcc@example.com - items: - format: email - maxItems: 3 - type: string - nullable: true - type: array - type: object - Error: - properties: - error_code: - description: "Specific error encountered when processing the request, can\ - \ refer to the API documentation on proper handling of each available\ - \ error code https://developers.xendit.co/api-reference/#payouts" - example: SERVER_ERROR - type: string - message: - description: Human readable error message - type: string - errors: - items: - $ref: '#/components/schemas/Error_errors_inner' - type: array - required: - - error_code - - message - type: object - ChannelAccountType: - description: Available account types (applicable for MY_DUITNOW) - enum: - - NATIONAL_ID - - MOBILE_NO - - PASSPORT - - BUSINESS_REGISTRATION - - BANK_ACCOUNT - type: string - ChannelCategory: - description: "Category of channel code, as some channels might require more\ - \ fields during processing" - enum: - - BANK - - EWALLET - - OTC - example: BANK - type: string - Channel: - description: Channel information where you can send the money to - properties: - channel_code: - description: "Destination channel to send the money to, prefixed by ISO-3166\ - \ country code" - example: ID_MANDIRI - type: string - channel_category: - $ref: '#/components/schemas/ChannelCategory' - currency: - description: Currency of the destination channel using ISO-4217 currency - code - example: IDR - type: string - channel_name: - description: Name of the destination channel - example: Bank Mandiri - type: string - amount_limits: - $ref: '#/components/schemas/Channel_amount_limits' - required: - - amount_limits - - channel_category - - channel_code - - channel_name - - currency - type: object - DigitalPayoutChannelProperties: - description: "Channel information for digital destinations (banks, e-wallets)" - example: - account_number: "9999999999" - account_type: null - account_holder_name: Adam Gilcrist - properties: - account_holder_name: - description: Registered account name - example: Adam Gilcrist - nullable: true - type: string - account_number: - description: Registered account number - example: "9999999999" - type: string - account_type: - $ref: '#/components/schemas/ChannelAccountType' - required: - - account_number - type: object - CreatePayoutRequest: - description: Information needed by Xendit to send money to the destination channel - provided - example: - amount: 15000.05 - metadata: - external_party: xendit - reference_id: DISB-001 - receipt_notification: - email_to: - - user_to@example.com - - user_to2@example.com - - user_to3@example.com - email_bcc: - - user_bcc@example.com - email_cc: - - user_cc@example.com - - user_cc2@example.com - description: Cashback 2020 - channel_properties: - account_number: "9999999999" - account_type: null - account_holder_name: Adam Gilcrist - currency: PHP - channel_code: PH_BDO - properties: - reference_id: - description: A client defined payout identifier - example: DISB-001 - minLength: 1 - type: string - channel_code: - description: Channel code of selected destination bank or e-wallet - example: PH_BDO - type: string - channel_properties: - $ref: '#/components/schemas/DigitalPayoutChannelProperties' - amount: - description: Amount to be sent to the destination account and should be - a multiple of the minimum increment for the selected channel - example: 15000.05 - type: number - description: - description: "Description to send with the payout, the recipient may see\ - \ this e.g., in their bank statement (if supported) or in email receipts\ - \ we send on your behalf" - example: Cashback 2020 - type: string - currency: - description: Currency of the destination channel using ISO-4217 currency - code - example: PHP - type: string - receipt_notification: - $ref: '#/components/schemas/ReceiptNotification' - metadata: - description: Object of additional information you may use - example: - external_party: xendit - type: object - required: - - amount - - channel_code - - channel_properties - - currency - - reference_id - type: object - Payout: - allOf: - - $ref: '#/components/schemas/CreatePayoutRequest' - - $ref: '#/components/schemas/Payout_allOf' - getPayouts_200_response_data_inner: - anyOf: - - $ref: '#/components/schemas/Payout' - getPayouts_200_response_links: - example: - method: method - rel: rel - href: href - properties: - href: - type: string - rel: - type: string - method: - type: string - type: object - getPayouts_200_response: - example: - data: - - null - - null - links: - method: method - rel: rel - href: href - has_more: true - properties: - data: - items: - $ref: '#/components/schemas/getPayouts_200_response_data_inner' - type: array - has_more: - type: boolean - links: - $ref: '#/components/schemas/getPayouts_200_response_links' - type: object - Error_errors_inner: - properties: - path: - description: Precise location of the error - type: string - message: - description: Specific description of the error - type: string - required: - - message - - path - type: object - Channel_amount_limits: - description: Supported amount ranges for payouts to this channel - properties: - minimum: - description: Lowest amount supported for a payout to this channel - example: 1 - type: number - maximum: - description: Highest amount supported for a payout to this channel - example: 50000000 - type: number - minimum_increment: - description: Supported increments - example: 1 - type: number - required: - - maximum - - minimum - - minimum_increment - type: object - Payout_allOf: - properties: - id: - description: Xendit-generated unique identifier for each payout - example: disb_4203234e-48f5-11eb-b378-0242ac130002 - type: string - created: - description: "The time payout was created on Xendit's system, in ISO 8601\ - \ format" - example: 2019-11-01T12:34:56.007Z - format: date-time - type: string - updated: - description: "The time payout was last updated on Xendit's system, in ISO\ - \ 8601 format" - example: 2019-11-01T12:34:56.007Z - format: date-time - type: string - business_id: - description: Xendit Business ID - example: 4203234e-48f5-11eb-b378-0242ac130002 - type: string - status: - description: Status of payout - enum: - - SUCCEEDED - - FAILED - - ACCEPTED - - REQUESTED - - LOCKED - - CANCELLED - - REVERSED - example: ACCEPTED - type: string - failure_code: - description: "If the Payout failed, we include a failure code for more details\ - \ on the failure." - enum: - - INSUFFICIENT_BALANCE - - REJECTED_BY_CHANNEL - - TEMPORARY_TRANSFER_ERROR - - INVALID_DESTINATION - - TRANSFER_ERROR - type: string - estimated_arrival_time: - description: Our estimated time on to when your payout is reflected to the - destination account - format: date-time - type: string - required: - - business_id - - created - - id - - status - - updated - type: object - example: null diff --git a/docs/payout/Channel.md b/docs/payout/Channel.md index 8fddb4d2..ab4c24c3 100644 --- a/docs/payout/Channel.md +++ b/docs/payout/Channel.md @@ -1,14 +1,14 @@ # Channel +Channel information where you can send the money to ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ChannelCode** | **string** | Destination channel to send the money to, prefixed by ISO-3166 country code | | -| **ChannelCategory** | [**ChannelCategory**](ChannelCategory.md) | | | -| **Currency** | **string** | Currency of the destination channel using ISO-4217 currency code | | -| **ChannelName** | **string** | Name of the destination channel | | -| **AmountLimits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ChannelCode** | **string** | ☑️ | Destination channel to send the money to, prefixed by ISO-3166 country code | | +| **ChannelCategory** | [**ChannelCategory**](ChannelCategory.md) | ☑️ | | | +| **Currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | +| **ChannelName** | **string** | ☑️ | Name of the destination channel | | +| **AmountLimits** | [**ChannelAmountLimits**](ChannelAmountLimits.md) | ☑️ | | | ## Methods diff --git a/docs/payout/ChannelAccountType.md b/docs/payout/ChannelAccountType.md index bdb53cea..96a3d17d 100644 --- a/docs/payout/ChannelAccountType.md +++ b/docs/payout/ChannelAccountType.md @@ -1,19 +1,19 @@ # ChannelAccountType - -## Enum - - -* `NATIONAL_ID` (value: `"NATIONAL_ID"`) - -* `MOBILE_NO` (value: `"MOBILE_NO"`) - -* `PASSPORT` (value: `"PASSPORT"`) - -* `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) - -* `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Available account types (applicable for MY_DUITNOW) + + ## Enum + + * `NATIONAL_ID` (value: `"NATIONAL_ID"`) + + * `MOBILE_NO` (value: `"MOBILE_NO"`) + + * `PASSPORT` (value: `"PASSPORT"`) + + * `BUSINESS_REGISTRATION` (value: `"BUSINESS_REGISTRATION"`) + + * `BANK_ACCOUNT` (value: `"BANK_ACCOUNT"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payout/ChannelAmountLimits.md b/docs/payout/ChannelAmountLimits.md index a45c827f..8d37a5c0 100644 --- a/docs/payout/ChannelAmountLimits.md +++ b/docs/payout/ChannelAmountLimits.md @@ -1,12 +1,12 @@ # ChannelAmountLimits +Supported amount ranges for payouts to this channel ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Minimum** | **float32** | Lowest amount supported for a payout to this channel | | -| **Maximum** | **float32** | Highest amount supported for a payout to this channel | | -| **MinimumIncrement** | **float32** | Supported increments | | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Minimum** | **float32** | ☑️ | Lowest amount supported for a payout to this channel | | +| **Maximum** | **float32** | ☑️ | Highest amount supported for a payout to this channel | | +| **MinimumIncrement** | **float32** | ☑️ | Supported increments | | ## Methods diff --git a/docs/payout/ChannelCategory.md b/docs/payout/ChannelCategory.md index 0110aab1..df1bd021 100644 --- a/docs/payout/ChannelCategory.md +++ b/docs/payout/ChannelCategory.md @@ -1,15 +1,15 @@ # ChannelCategory - -## Enum - - -* `BANK` (value: `"BANK"`) - -* `EWALLET` (value: `"EWALLET"`) - -* `OTC` (value: `"OTC"`) - -* `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) +Category of channel code, as some channels might require more fields during processing + + ## Enum + + * `BANK` (value: `"BANK"`) + + * `EWALLET` (value: `"EWALLET"`) + + * `OTC` (value: `"OTC"`) + + * `XENDIT_ENUM_DEFAULT_FALLBACK` (value: `UNKNOWN_ENUM_VALUE`) If you encounter `UNKNOWN_ENUM_VALUE`, it means that this ENUM is unavailable in your current SDK version. Please upgrade to get the newest ENUM. diff --git a/docs/payout/CreatePayoutRequest.md b/docs/payout/CreatePayoutRequest.md index 139a7a69..944813fd 100644 --- a/docs/payout/CreatePayoutRequest.md +++ b/docs/payout/CreatePayoutRequest.md @@ -1,17 +1,17 @@ # CreatePayoutRequest +Information needed by Xendit to send money to the destination channel provided ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | **string** | A client defined payout identifier | | -| **ChannelCode** | **string** | Channel code of selected destination bank or e-wallet | | -| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | -| **Amount** | **float32** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | -| **Description** | Pointer to **string** | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | [optional] | -| **Currency** | **string** | Currency of the destination channel using ISO-4217 currency code | | -| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | Object of additional information you may use | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | **string** | ☑️ | A client defined payout identifier | | +| **ChannelCode** | **string** | ☑️ | Channel code of selected destination bank or e-wallet | | +| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | +| **Amount** | **float32** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | +| **Description** | Pointer to **string** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | +| **Currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | +| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | Object of additional information you may use | | ## Methods diff --git a/docs/payout/DigitalPayoutChannelProperties.md b/docs/payout/DigitalPayoutChannelProperties.md index 87bcf46e..b3407bff 100644 --- a/docs/payout/DigitalPayoutChannelProperties.md +++ b/docs/payout/DigitalPayoutChannelProperties.md @@ -1,12 +1,12 @@ # DigitalPayoutChannelProperties +Channel information for digital destinations (banks, e-wallets) ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **AccountHolderName** | Pointer to **NullableString** | Registered account name | [optional] | -| **AccountNumber** | **string** | Registered account number | | -| **AccountType** | Pointer to [**ChannelAccountType**](ChannelAccountType.md) | | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **AccountHolderName** | Pointer to **NullableString** | | Registered account name | | +| **AccountNumber** | **string** | ☑️ | Registered account number | | +| **AccountType** | Pointer to [**ChannelAccountType**](ChannelAccountType.md) | | | | ## Methods diff --git a/docs/payout/Error.md b/docs/payout/Error.md index af3b4e0d..e0b4b111 100644 --- a/docs/payout/Error.md +++ b/docs/payout/Error.md @@ -1,12 +1,12 @@ # Error -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | **string** | Specific error encountered when processing the request, can refer to the API documentation on proper handling of each available error code https://developers.xendit.co/api-reference/#payouts | | -| **Message** | **string** | Human readable error message | | -| **Errors** | Pointer to [**ErrorErrorsInner[]**](ErrorErrorsInner.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | **string** | ☑️ | Specific error encountered when processing the request, can refer to the API documentation on proper handling of each available error code https://developers.xendit.co/api-reference/#payouts | | +| **Message** | **string** | ☑️ | Human readable error message | | +| **Errors** | Pointer to [**ErrorErrorsInner[]**](ErrorErrorsInner.md) | | | | ## Methods diff --git a/docs/payout/ErrorErrorsInner.md b/docs/payout/ErrorErrorsInner.md index 539975c8..c9df4e5b 100644 --- a/docs/payout/ErrorErrorsInner.md +++ b/docs/payout/ErrorErrorsInner.md @@ -1,11 +1,11 @@ # ErrorErrorsInner -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Path** | **string** | Precise location of the error | | -| **Message** | **string** | Specific description of the error | | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Path** | **string** | ☑️ | Precise location of the error | | +| **Message** | **string** | ☑️ | Specific description of the error | | ## Methods diff --git a/docs/payout/GetPayouts200Response.md b/docs/payout/GetPayouts200Response.md index 9a223cb5..b7ada66e 100644 --- a/docs/payout/GetPayouts200Response.md +++ b/docs/payout/GetPayouts200Response.md @@ -1,12 +1,12 @@ # GetPayouts200Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Data** | Pointer to [**GetPayouts200ResponseDataInner[]**](GetPayouts200ResponseDataInner.md) | | [optional] | -| **HasMore** | Pointer to **bool** | | [optional] | -| **Links** | Pointer to [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Data** | Pointer to [**GetPayouts200ResponseDataInner[]**](GetPayouts200ResponseDataInner.md) | | | | +| **HasMore** | Pointer to **bool** | | | | +| **Links** | Pointer to [**GetPayouts200ResponseLinks**](GetPayouts200ResponseLinks.md) | | | | ## Methods diff --git a/docs/payout/GetPayouts200ResponseDataInner.md b/docs/payout/GetPayouts200ResponseDataInner.md index ad7616a0..ef870882 100644 --- a/docs/payout/GetPayouts200ResponseDataInner.md +++ b/docs/payout/GetPayouts200ResponseDataInner.md @@ -1,24 +1,24 @@ # GetPayouts200ResponseDataInner -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | **string** | A client defined payout identifier | | -| **ChannelCode** | **string** | Channel code of selected destination bank or e-wallet | | -| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | -| **Amount** | **float32** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | -| **Description** | Pointer to **string** | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | [optional] | -| **Currency** | **string** | Currency of the destination channel using ISO-4217 currency code | | -| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | Object of additional information you may use | [optional] | -| **Id** | **string** | Xendit-generated unique identifier for each payout | | -| **Created** | **time.Time** | The time payout was created on Xendit's system, in ISO 8601 format | | -| **Updated** | **time.Time** | The time payout was last updated on Xendit's system, in ISO 8601 format | | -| **BusinessId** | **string** | Xendit Business ID | | -| **Status** | **string** | Status of payout | | -| **FailureCode** | Pointer to **string** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **EstimatedArrivalTime** | Pointer to **time.Time** | Our estimated time on to when your payout is reflected to the destination account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | **string** | ☑️ | A client defined payout identifier | | +| **ChannelCode** | **string** | ☑️ | Channel code of selected destination bank or e-wallet | | +| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | +| **Amount** | **float32** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | +| **Description** | Pointer to **string** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | +| **Currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | +| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | Object of additional information you may use | | +| **Id** | **string** | ☑️ | Xendit-generated unique identifier for each payout | | +| **Created** | **time.Time** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | +| **Updated** | **time.Time** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | +| **BusinessId** | **string** | ☑️ | Xendit Business ID | | +| **Status** | **string** | ☑️ | Status of payout | | +| **FailureCode** | Pointer to **string** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **EstimatedArrivalTime** | Pointer to **time.Time** | | Our estimated time on to when your payout is reflected to the destination account | | ## Methods diff --git a/docs/payout/GetPayouts200ResponseLinks.md b/docs/payout/GetPayouts200ResponseLinks.md index 92e6c8e1..7754a316 100644 --- a/docs/payout/GetPayouts200ResponseLinks.md +++ b/docs/payout/GetPayouts200ResponseLinks.md @@ -1,12 +1,12 @@ # GetPayouts200ResponseLinks -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Href** | Pointer to **string** | | [optional] | -| **Rel** | Pointer to **string** | | [optional] | -| **Method** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Href** | Pointer to **string** | | | | +| **Rel** | Pointer to **string** | | | | +| **Method** | Pointer to **string** | | | | ## Methods diff --git a/docs/payout/Payout.md b/docs/payout/Payout.md index 658c76b0..fb87bb92 100644 --- a/docs/payout/Payout.md +++ b/docs/payout/Payout.md @@ -1,24 +1,24 @@ # Payout -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ReferenceId** | **string** | A client defined payout identifier | | -| **ChannelCode** | **string** | Channel code of selected destination bank or e-wallet | | -| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | | | -| **Amount** | **float32** | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | -| **Description** | Pointer to **string** | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | [optional] | -| **Currency** | **string** | Currency of the destination channel using ISO-4217 currency code | | -| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | Object of additional information you may use | [optional] | -| **Id** | **string** | Xendit-generated unique identifier for each payout | | -| **Created** | **time.Time** | The time payout was created on Xendit's system, in ISO 8601 format | | -| **Updated** | **time.Time** | The time payout was last updated on Xendit's system, in ISO 8601 format | | -| **BusinessId** | **string** | Xendit Business ID | | -| **Status** | **string** | Status of payout | | -| **FailureCode** | Pointer to **string** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **EstimatedArrivalTime** | Pointer to **time.Time** | Our estimated time on to when your payout is reflected to the destination account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ReferenceId** | **string** | ☑️ | A client defined payout identifier | | +| **ChannelCode** | **string** | ☑️ | Channel code of selected destination bank or e-wallet | | +| **ChannelProperties** | [**DigitalPayoutChannelProperties**](DigitalPayoutChannelProperties.md) | ☑️ | | | +| **Amount** | **float32** | ☑️ | Amount to be sent to the destination account and should be a multiple of the minimum increment for the selected channel | | +| **Description** | Pointer to **string** | | Description to send with the payout, the recipient may see this e.g., in their bank statement (if supported) or in email receipts we send on your behalf | | +| **Currency** | **string** | ☑️ | Currency of the destination channel using ISO-4217 currency code | | +| **ReceiptNotification** | Pointer to [**ReceiptNotification**](ReceiptNotification.md) | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | Object of additional information you may use | | +| **Id** | **string** | ☑️ | Xendit-generated unique identifier for each payout | | +| **Created** | **time.Time** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | +| **Updated** | **time.Time** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | +| **BusinessId** | **string** | ☑️ | Xendit Business ID | | +| **Status** | **string** | ☑️ | Status of payout | | +| **FailureCode** | Pointer to **string** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **EstimatedArrivalTime** | Pointer to **time.Time** | | Our estimated time on to when your payout is reflected to the destination account | | ## Methods diff --git a/docs/payout/PayoutAllOf.md b/docs/payout/PayoutAllOf.md index b598f0cf..86b49d10 100644 --- a/docs/payout/PayoutAllOf.md +++ b/docs/payout/PayoutAllOf.md @@ -1,16 +1,16 @@ # PayoutAllOf -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | **string** | Xendit-generated unique identifier for each payout | | -| **Created** | **time.Time** | The time payout was created on Xendit's system, in ISO 8601 format | | -| **Updated** | **time.Time** | The time payout was last updated on Xendit's system, in ISO 8601 format | | -| **BusinessId** | **string** | Xendit Business ID | | -| **Status** | **string** | Status of payout | | -| **FailureCode** | Pointer to **string** | If the Payout failed, we include a failure code for more details on the failure. | [optional] | -| **EstimatedArrivalTime** | Pointer to **time.Time** | Our estimated time on to when your payout is reflected to the destination account | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | **string** | ☑️ | Xendit-generated unique identifier for each payout | | +| **Created** | **time.Time** | ☑️ | The time payout was created on Xendit's system, in ISO 8601 format | | +| **Updated** | **time.Time** | ☑️ | The time payout was last updated on Xendit's system, in ISO 8601 format | | +| **BusinessId** | **string** | ☑️ | Xendit Business ID | | +| **Status** | **string** | ☑️ | Status of payout | | +| **FailureCode** | Pointer to **string** | | If the Payout failed, we include a failure code for more details on the failure. | | +| **EstimatedArrivalTime** | Pointer to **time.Time** | | Our estimated time on to when your payout is reflected to the destination account | | ## Methods diff --git a/docs/payout/ReceiptNotification.md b/docs/payout/ReceiptNotification.md index 321918a7..4ca7f4c7 100644 --- a/docs/payout/ReceiptNotification.md +++ b/docs/payout/ReceiptNotification.md @@ -1,12 +1,12 @@ # ReceiptNotification +Additional notification for completed payout ## Properties - -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **EmailTo** | Pointer to **string[]** | Valid email address to send the payout receipt | [optional] | -| **EmailCc** | Pointer to **string[]** | Valid email address to cc the payout receipt | [optional] | -| **EmailBcc** | Pointer to **string[]** | Valid email address to bcc the payout receipt | [optional] | +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **EmailTo** | Pointer to **string[]** | | Valid email address to send the payout receipt | | +| **EmailCc** | Pointer to **string[]** | | Valid email address to cc the payout receipt | | +| **EmailBcc** | Pointer to **string[]** | | Valid email address to bcc the payout receipt | | ## Methods diff --git a/docs/refund.yaml b/docs/refund.yaml deleted file mode 100644 index cb698a39..00000000 --- a/docs/refund.yaml +++ /dev/null @@ -1,569 +0,0 @@ -openapi: 3.0.0 -info: - description: This API is used for the unified refund service - title: Refund Service - version: 1.3.3 -servers: -- description: Xendit API Server - url: https://api.xendit.co -paths: - /refunds: - get: - operationId: getAllRefunds - parameters: - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - - explode: true - in: query - name: payment_request_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: invoice_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: payment_method_type - required: false - schema: - type: string - style: form - - explode: true - in: query - name: channel_code - required: false - schema: - type: string - style: form - - explode: true - in: query - name: limit - required: false - schema: - type: number - style: form - - explode: true - in: query - name: after_id - required: false - schema: - type: string - style: form - - explode: true - in: query - name: before_id - required: false - schema: - type: string - style: form - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/RefundList' - description: OK - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllRefunds_default_response' - description: Internal server error - tags: - - refund - post: - operationId: createRefund - parameters: - - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 9797b5a6-54ad-4511-80a4-ec451346808b - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateRefund' - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Refund' - description: OK - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_404_response' - description: Data not found - "409": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_409_response' - description: Request causes conflict - "503": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_503_response' - description: Service is unavailable due to dependencies - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllRefunds_default_response' - description: Internal server error - tags: - - refund - /refunds/{refundID}: - get: - operationId: getRefund - parameters: - - explode: false - in: path - name: refundID - required: true - schema: - example: rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 9797b5a6-54ad-4511-80a4-ec451346808b - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Refund' - description: OK - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllRefunds_default_response' - description: Internal server error - tags: - - refund - /refunds/{refundID}/cancel: - post: - operationId: cancelRefund - parameters: - - explode: false - in: path - name: refundID - required: true - schema: - example: rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 9797b5a6-54ad-4511-80a4-ec451346808b - type: string - style: simple - - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/Refund' - description: OK - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_400_response' - description: Bad request - "403": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_403_response' - description: Forbidden due to permissions - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_404_response' - description: Data not found - default: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllRefunds_default_response' - description: Internal server error - tags: - - refund -components: - parameters: - RefundID: - explode: false - in: path - name: refundID - required: true - schema: - example: rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822 - type: string - style: simple - IdempotencyKey: - explode: false - in: header - name: idempotency-key - required: false - schema: - example: 9797b5a6-54ad-4511-80a4-ec451346808b - type: string - style: simple - ForUserId: - explode: false - in: header - name: for-user-id - required: false - schema: - example: 5f9a3fbd571a1c4068aa40ce - type: string - style: simple - responses: - InternalServerError: - content: - application/json: - schema: - $ref: '#/components/schemas/getAllRefunds_default_response' - description: Internal server error - StatusBadRequest: - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_400_response' - description: Bad request - StatusForbidden: - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_403_response' - description: Forbidden due to permissions - StatusNotFound: - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_404_response' - description: Data not found - StatusConflict: - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_409_response' - description: Request causes conflict - StatusServiceUnavailable: - content: - application/json: - schema: - $ref: '#/components/schemas/createRefund_503_response' - description: Service is unavailable due to dependencies - schemas: - Refund: - example: - country: PH - amount: 1500 - failure_code: REFUND_FAILED - metadata: "{}" - reference_id: order-1234 - refund_fee_amount: 0.8008281904610115 - created: 2023-01-24T07:05:07.859363326Z - currency: PHP - id: rfd-3ece8615-41b7-4983-a3f0-a037430b6036 - payment_request_id: pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee - channel_code: SHOPEEPAY - updated: 2023-01-24T07:05:07.859363326Z - properties: - id: - example: rfd-3ece8615-41b7-4983-a3f0-a037430b6036 - type: string - payment_request_id: - example: pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee - type: string - amount: - example: 1500 - format: double - type: number - channel_code: - example: SHOPEEPAY - type: string - country: - example: PH - type: string - currency: - example: PHP - type: string - reference_id: - example: order-1234 - nullable: true - type: string - failure_code: - example: REFUND_FAILED - nullable: true - type: string - refund_fee_amount: - format: double - nullable: true - type: number - example: null - created: - example: 2023-01-24T07:05:07.859363326Z - type: string - updated: - example: 2023-01-24T07:05:07.859363326Z - type: string - metadata: - nullable: true - type: object - example: null - type: object - RefundList: - example: - data: - - id: rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822' - payment_request_id: pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee - amount: 1500 - channel_code: SHOPEEPAY - country: PH - currency: PHP - reference_id: order-1234 - failure_code: null - refund_fee_amount: null - created: 2023-01-24T07:05:07.859363326Z - updated: 2023-01-24T07:05:07.859363326Z - metadata: null - - id: rfd-db61bc21-8686-49d9-9be1-168cbf45d83f' - payment_request_id: pr-3af41122-a608-4356-a0fe-1f67f5cf4637 - amount: 1500 - channel_code: GRABPAY - country: PH - currency: PHP - reference_id: order-5678 - failure_code: null - refund_fee_amount: null - created: 2023-01-24T07:05:07.859363326Z - updated: 2023-01-24T07:05:07.859363326Z - metadata: null - has_more: false - nullable: false - properties: - data: - example: - - id: rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822' - payment_request_id: pr-f4a6f77c-4835-4630-9617-2cdc34ee26ee - amount: 1500 - channel_code: SHOPEEPAY - country: PH - currency: PHP - reference_id: order-1234 - failure_code: null - refund_fee_amount: null - created: 2023-01-24T07:05:07.859363326Z - updated: 2023-01-24T07:05:07.859363326Z - metadata: null - - id: rfd-db61bc21-8686-49d9-9be1-168cbf45d83f' - payment_request_id: pr-3af41122-a608-4356-a0fe-1f67f5cf4637 - amount: 1500 - channel_code: GRABPAY - country: PH - currency: PHP - reference_id: order-5678 - failure_code: null - refund_fee_amount: null - created: 2023-01-24T07:05:07.859363326Z - updated: 2023-01-24T07:05:07.859363326Z - metadata: null - items: - $ref: '#/components/schemas/Refund' - type: array - has_more: - example: false - type: boolean - required: - - data - type: object - CreateRefund: - example: - reason: CANCELLATION - amount: 1500 - metadata: - foo: bar - reference_id: order-1234 - invoice_id: 7a2c81d4f9e052a870bf37d2 - currency: PHP - payment_request_id: pr-3ece8615-41b7-4983-a3f0-a037430b6036 - nullable: false - properties: - payment_request_id: - example: pr-3ece8615-41b7-4983-a3f0-a037430b6036 - type: string - invoice_id: - example: 7a2c81d4f9e052a870bf37d2 - type: string - reference_id: - example: order-1234 - type: string - amount: - example: 1500 - format: double - type: number - currency: - example: PHP - type: string - reason: - enum: - - FRAUDULENT - - DUPLICATE - - REQUESTED_BY_CUSTOMER - - CANCELLATION - - OTHERS - example: CANCELLATION - type: string - metadata: - example: - foo: bar - nullable: true - type: object - type: object - getAllRefunds_default_response: - example: - error_code: SERVER_ERROR - message: An unexpected error occured. Our team has been notified and will - troubleshoot the issue. - properties: - error_code: - type: string - message: - example: An unexpected error occured. Our team has been notified and will - troubleshoot the issue. - type: string - type: object - createRefund_400_response: - properties: - error_code: - enum: - - API_VALIDATION_ERROR - - INELIGIBLE_TRANSACTION - - INSUFFICIENT_BALANCE - - MAXIMUM_REFUND_AMOUNT_REACHED - - PARTIAL_REFUND_NOT_SUPPORTED - - REFUND_NOT_SUPPORTED - - TRANSACTION_NOT_FOUND - example: MAXIMUM_REFUND_AMOUNT_REACHED - type: string - message: - example: Error because the provided amount is greater than the allowed refund - amount. - type: string - type: object - createRefund_403_response: - properties: - error_code: - enum: - - UNAUTHORIZED - example: UNAUTHORIZED - type: string - message: - example: No valid API key provided - type: string - type: object - createRefund_404_response: - properties: - error_code: - enum: - - DATA_NOT_FOUND - example: DATA_NOT_FOUND - type: string - message: - example: Data not found - type: string - type: object - createRefund_409_response: - properties: - error_code: - enum: - - DUPLICATE_ERROR - - IDEMPOTENCY_ERROR - example: DUPLICATE_ERROR - type: string - message: - example: "duplicate value on idempotency_key, try again with a new key" - type: string - type: object - createRefund_503_response: - properties: - error_code: - enum: - - CHANNEL_UNAVAILABLE - - OTP_DELIVERY_ERROR - example: CHANNEL_UNAVAILABLE - type: string - message: - example: The payment channel requested is currently experiencing unexpected - issues. - type: string - type: object diff --git a/docs/refund/CreateRefund.md b/docs/refund/CreateRefund.md index 7d669d17..d7c1a87f 100644 --- a/docs/refund/CreateRefund.md +++ b/docs/refund/CreateRefund.md @@ -1,16 +1,16 @@ # CreateRefund -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **PaymentRequestId** | Pointer to **string** | | [optional] | -| **InvoiceId** | Pointer to **string** | | [optional] | -| **ReferenceId** | Pointer to **string** | | [optional] | -| **Amount** | Pointer to **float64** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **Reason** | Pointer to **string** | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **PaymentRequestId** | Pointer to **string** | | | | +| **InvoiceId** | Pointer to **string** | | | | +| **ReferenceId** | Pointer to **string** | | | | +| **Amount** | Pointer to **float64** | | | | +| **Currency** | Pointer to **string** | | | | +| **Reason** | Pointer to **string** | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/refund/CreateRefund400Response.md b/docs/refund/CreateRefund400Response.md index 2f0809a6..a0370752 100644 --- a/docs/refund/CreateRefund400Response.md +++ b/docs/refund/CreateRefund400Response.md @@ -1,11 +1,11 @@ # CreateRefund400Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/CreateRefund403Response.md b/docs/refund/CreateRefund403Response.md index 1c92e134..6ea9c940 100644 --- a/docs/refund/CreateRefund403Response.md +++ b/docs/refund/CreateRefund403Response.md @@ -1,11 +1,11 @@ # CreateRefund403Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/CreateRefund404Response.md b/docs/refund/CreateRefund404Response.md index 83c0bdf0..05513e85 100644 --- a/docs/refund/CreateRefund404Response.md +++ b/docs/refund/CreateRefund404Response.md @@ -1,11 +1,11 @@ # CreateRefund404Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/CreateRefund409Response.md b/docs/refund/CreateRefund409Response.md index c76490ec..e1158422 100644 --- a/docs/refund/CreateRefund409Response.md +++ b/docs/refund/CreateRefund409Response.md @@ -1,11 +1,11 @@ # CreateRefund409Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/CreateRefund503Response.md b/docs/refund/CreateRefund503Response.md index 46284ecd..c3f39668 100644 --- a/docs/refund/CreateRefund503Response.md +++ b/docs/refund/CreateRefund503Response.md @@ -1,11 +1,11 @@ # CreateRefund503Response -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/GetAllRefundsDefaultResponse.md b/docs/refund/GetAllRefundsDefaultResponse.md index 31f32bc6..e6422e5c 100644 --- a/docs/refund/GetAllRefundsDefaultResponse.md +++ b/docs/refund/GetAllRefundsDefaultResponse.md @@ -1,11 +1,11 @@ # GetAllRefundsDefaultResponse -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **ErrorCode** | Pointer to **string** | | [optional] | -| **Message** | Pointer to **string** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **ErrorCode** | Pointer to **string** | | | | +| **Message** | Pointer to **string** | | | | ## Methods diff --git a/docs/refund/Refund.md b/docs/refund/Refund.md index 7dae07d6..f5738f52 100644 --- a/docs/refund/Refund.md +++ b/docs/refund/Refund.md @@ -1,21 +1,21 @@ # Refund -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Id** | Pointer to **string** | | [optional] | -| **PaymentRequestId** | Pointer to **string** | | [optional] | -| **Amount** | Pointer to **float64** | | [optional] | -| **ChannelCode** | Pointer to **string** | | [optional] | -| **Country** | Pointer to **string** | | [optional] | -| **Currency** | Pointer to **string** | | [optional] | -| **ReferenceId** | Pointer to **NullableString** | | [optional] | -| **FailureCode** | Pointer to **NullableString** | | [optional] | -| **RefundFeeAmount** | Pointer to **NullableFloat64** | | [optional] | -| **Created** | Pointer to **string** | | [optional] | -| **Updated** | Pointer to **string** | | [optional] | -| **Metadata** | Pointer to **map[string]interface{}** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Id** | Pointer to **string** | | | | +| **PaymentRequestId** | Pointer to **string** | | | | +| **Amount** | Pointer to **float64** | | | | +| **ChannelCode** | Pointer to **string** | | | | +| **Country** | Pointer to **string** | | | | +| **Currency** | Pointer to **string** | | | | +| **ReferenceId** | Pointer to **NullableString** | | | | +| **FailureCode** | Pointer to **NullableString** | | | | +| **RefundFeeAmount** | Pointer to **NullableFloat64** | | | | +| **Created** | Pointer to **string** | | | | +| **Updated** | Pointer to **string** | | | | +| **Metadata** | Pointer to **map[string]interface{}** | | | | ## Methods diff --git a/docs/refund/RefundList.md b/docs/refund/RefundList.md index b4ab01ee..41eaacc3 100644 --- a/docs/refund/RefundList.md +++ b/docs/refund/RefundList.md @@ -1,11 +1,11 @@ # RefundList -## Properties -| Name | Type | Description | Notes | -| ------------ | ------------- | ------------- | ------------- | -| **Data** | [**Refund[]**](Refund.md) | | | -| **HasMore** | Pointer to **bool** | | [optional] | +## Properties +| Name | Type | Required | Description | Examples | +|------------|:-------------:|:-------------:|-------------|:-------------:| +| **Data** | [**Refund[]**](Refund.md) | ☑️ | | | +| **HasMore** | Pointer to **bool** | | | | ## Methods diff --git a/docs/header.jpg b/images/header.jpg similarity index 100% rename from docs/header.jpg rename to images/header.jpg diff --git a/payment_method/model_billing_information.go b/payment_method/model_billing_information.go index f7e12111..a7619051 100644 --- a/payment_method/model_billing_information.go +++ b/payment_method/model_billing_information.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card.go b/payment_method/model_card.go index a7b00268..ebe63513 100644 --- a/payment_method/model_card.go +++ b/payment_method/model_card.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card_channel_properties.go b/payment_method/model_card_channel_properties.go index 385e3996..d499a212 100644 --- a/payment_method/model_card_channel_properties.go +++ b/payment_method/model_card_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card_parameters.go b/payment_method/model_card_parameters.go index 5588b728..c588bd43 100644 --- a/payment_method/model_card_parameters.go +++ b/payment_method/model_card_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card_parameters_card_information.go b/payment_method/model_card_parameters_card_information.go index 09b47cad..252cea9f 100644 --- a/payment_method/model_card_parameters_card_information.go +++ b/payment_method/model_card_parameters_card_information.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card_verification_results.go b/payment_method/model_card_verification_results.go index 157bc638..636ca846 100644 --- a/payment_method/model_card_verification_results.go +++ b/payment_method/model_card_verification_results.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_card_verification_results_three_d_secure.go b/payment_method/model_card_verification_results_three_d_secure.go index ac0c3936..aa2f5aa2 100644 --- a/payment_method/model_card_verification_results_three_d_secure.go +++ b/payment_method/model_card_verification_results_three_d_secure.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_create_payment_method_409_response.go b/payment_method/model_create_payment_method_409_response.go index 0b68b71d..184d0a89 100644 --- a/payment_method/model_create_payment_method_409_response.go +++ b/payment_method/model_create_payment_method_409_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_create_payment_method_503_response.go b/payment_method/model_create_payment_method_503_response.go index 21cee348..37fc9f31 100644 --- a/payment_method/model_create_payment_method_503_response.go +++ b/payment_method/model_create_payment_method_503_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit.go b/payment_method/model_direct_debit.go index 024f7ed4..72cc9e0c 100644 --- a/payment_method/model_direct_debit.go +++ b/payment_method/model_direct_debit.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit_all_of.go b/payment_method/model_direct_debit_all_of.go index 875f4f05..38486e12 100644 --- a/payment_method/model_direct_debit_all_of.go +++ b/payment_method/model_direct_debit_all_of.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit_bank_account.go b/payment_method/model_direct_debit_bank_account.go index 32d2109a..e1fc76e3 100644 --- a/payment_method/model_direct_debit_bank_account.go +++ b/payment_method/model_direct_debit_bank_account.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit_channel_code.go b/payment_method/model_direct_debit_channel_code.go index 18e79a70..0dff60eb 100644 --- a/payment_method/model_direct_debit_channel_code.go +++ b/payment_method/model_direct_debit_channel_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit_channel_properties.go b/payment_method/model_direct_debit_channel_properties.go index b6cdca8e..23498118 100644 --- a/payment_method/model_direct_debit_channel_properties.go +++ b/payment_method/model_direct_debit_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ @@ -33,6 +33,8 @@ type DirectDebitChannelProperties struct { // Identity number of the customer registered to the partner channel IdentityDocumentNumber NullableString `json:"identity_document_number,omitempty"` RequireAuth NullableBool `json:"require_auth,omitempty"` + // Account number of the customer + AccountNumber NullableString `json:"account_number,omitempty"` } // NewDirectDebitChannelProperties instantiates a new DirectDebitChannelProperties object @@ -378,6 +380,48 @@ func (o *DirectDebitChannelProperties) UnsetRequireAuth() { o.RequireAuth.Unset() } +// GetAccountNumber returns the AccountNumber field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *DirectDebitChannelProperties) GetAccountNumber() string { + if o == nil || utils.IsNil(o.AccountNumber.Get()) { + var ret string + return ret + } + return *o.AccountNumber.Get() +} + +// GetAccountNumberOk returns a tuple with the AccountNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *DirectDebitChannelProperties) GetAccountNumberOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.AccountNumber.Get(), o.AccountNumber.IsSet() +} + +// HasAccountNumber returns a boolean if a field has been set. +func (o *DirectDebitChannelProperties) HasAccountNumber() bool { + if o != nil && o.AccountNumber.IsSet() { + return true + } + + return false +} + +// SetAccountNumber gets a reference to the given NullableString and assigns it to the AccountNumber field. +func (o *DirectDebitChannelProperties) SetAccountNumber(v string) { + o.AccountNumber.Set(&v) +} +// SetAccountNumberNil sets the value for AccountNumber to be an explicit nil +func (o *DirectDebitChannelProperties) SetAccountNumberNil() { + o.AccountNumber.Set(nil) +} + +// UnsetAccountNumber ensures that no value is present for AccountNumber, not even an explicit nil +func (o *DirectDebitChannelProperties) UnsetAccountNumber() { + o.AccountNumber.Unset() +} + func (o DirectDebitChannelProperties) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -411,6 +455,9 @@ func (o DirectDebitChannelProperties) ToMap() (map[string]interface{}, error) { } if o.RequireAuth.IsSet() { toSerialize["require_auth"] = o.RequireAuth.Get() + } + if o.AccountNumber.IsSet() { + toSerialize["account_number"] = o.AccountNumber.Get() } return toSerialize, nil } diff --git a/payment_method/model_direct_debit_debit_card.go b/payment_method/model_direct_debit_debit_card.go index af80e807..8f807a8d 100644 --- a/payment_method/model_direct_debit_debit_card.go +++ b/payment_method/model_direct_debit_debit_card.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ @@ -28,6 +28,8 @@ type DirectDebitDebitCard struct { CardExpiry NullableString `json:"card_expiry,omitempty"` // Email address of the customer that is registered to the partner channel Email NullableString `json:"email,omitempty"` + // Account number of the customer + AccountNumber NullableString `json:"account_number,omitempty"` } // NewDirectDebitDebitCard instantiates a new DirectDebitDebitCard object @@ -215,6 +217,48 @@ func (o *DirectDebitDebitCard) UnsetEmail() { o.Email.Unset() } +// GetAccountNumber returns the AccountNumber field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *DirectDebitDebitCard) GetAccountNumber() string { + if o == nil || utils.IsNil(o.AccountNumber.Get()) { + var ret string + return ret + } + return *o.AccountNumber.Get() +} + +// GetAccountNumberOk returns a tuple with the AccountNumber field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *DirectDebitDebitCard) GetAccountNumberOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.AccountNumber.Get(), o.AccountNumber.IsSet() +} + +// HasAccountNumber returns a boolean if a field has been set. +func (o *DirectDebitDebitCard) HasAccountNumber() bool { + if o != nil && o.AccountNumber.IsSet() { + return true + } + + return false +} + +// SetAccountNumber gets a reference to the given NullableString and assigns it to the AccountNumber field. +func (o *DirectDebitDebitCard) SetAccountNumber(v string) { + o.AccountNumber.Set(&v) +} +// SetAccountNumberNil sets the value for AccountNumber to be an explicit nil +func (o *DirectDebitDebitCard) SetAccountNumberNil() { + o.AccountNumber.Set(nil) +} + +// UnsetAccountNumber ensures that no value is present for AccountNumber, not even an explicit nil +func (o *DirectDebitDebitCard) UnsetAccountNumber() { + o.AccountNumber.Unset() +} + func (o DirectDebitDebitCard) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -236,6 +280,9 @@ func (o DirectDebitDebitCard) ToMap() (map[string]interface{}, error) { } if o.Email.IsSet() { toSerialize["email"] = o.Email.Get() + } + if o.AccountNumber.IsSet() { + toSerialize["account_number"] = o.AccountNumber.Get() } return toSerialize, nil } diff --git a/payment_method/model_direct_debit_parameters.go b/payment_method/model_direct_debit_parameters.go index d454c449..438ba0d6 100644 --- a/payment_method/model_direct_debit_parameters.go +++ b/payment_method/model_direct_debit_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_direct_debit_type.go b/payment_method/model_direct_debit_type.go index ca0eec47..2ed4c638 100644 --- a/payment_method/model_direct_debit_type.go +++ b/payment_method/model_direct_debit_type.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_e_wallet.go b/payment_method/model_e_wallet.go index 04e977a4..732e4385 100644 --- a/payment_method/model_e_wallet.go +++ b/payment_method/model_e_wallet.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_e_wallet_account.go b/payment_method/model_e_wallet_account.go index 26cfd0f8..d4bc446b 100644 --- a/payment_method/model_e_wallet_account.go +++ b/payment_method/model_e_wallet_account.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_e_wallet_channel_code.go b/payment_method/model_e_wallet_channel_code.go index a0164e26..cc1345cc 100644 --- a/payment_method/model_e_wallet_channel_code.go +++ b/payment_method/model_e_wallet_channel_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ @@ -40,6 +40,7 @@ const ( EWALLETCHANNELCODE_LINEPAY EWalletChannelCode = "LINEPAY" EWALLETCHANNELCODE_TRUEMONEY EWalletChannelCode = "TRUEMONEY" EWALLETCHANNELCODE_ALIPAY EWalletChannelCode = "ALIPAY" + EWALLETCHANNELCODE_TOUCHANDGO EWalletChannelCode = "TOUCHANDGO" EWALLETCHANNELCODE_XENDIT_ENUM_DEFAULT_FALLBACK EWalletChannelCode = "UNKNOWN_ENUM_VALUE" ) @@ -65,6 +66,7 @@ var AllowedEWalletChannelCodeEnumValues = []EWalletChannelCode{ "LINEPAY", "TRUEMONEY", "ALIPAY", + "TOUCHANDGO", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_method/model_e_wallet_channel_properties.go b/payment_method/model_e_wallet_channel_properties.go index 9686354e..f6d4ec26 100644 --- a/payment_method/model_e_wallet_channel_properties.go +++ b/payment_method/model_e_wallet_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_e_wallet_parameters.go b/payment_method/model_e_wallet_parameters.go index cf06ba09..6ed9e0f7 100644 --- a/payment_method/model_e_wallet_parameters.go +++ b/payment_method/model_e_wallet_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_get_all_payment_methods_400_response.go b/payment_method/model_get_all_payment_methods_400_response.go index 2e9cf969..1140e535 100644 --- a/payment_method/model_get_all_payment_methods_400_response.go +++ b/payment_method/model_get_all_payment_methods_400_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_get_all_payment_methods_403_response.go b/payment_method/model_get_all_payment_methods_403_response.go index 34cf98cd..d30fdca8 100644 --- a/payment_method/model_get_all_payment_methods_403_response.go +++ b/payment_method/model_get_all_payment_methods_403_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_get_all_payment_methods_404_response.go b/payment_method/model_get_all_payment_methods_404_response.go index 8ed4bae5..4310d4bf 100644 --- a/payment_method/model_get_all_payment_methods_404_response.go +++ b/payment_method/model_get_all_payment_methods_404_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_get_all_payment_methods_default_response.go b/payment_method/model_get_all_payment_methods_default_response.go index 8717b231..c6f4104d 100644 --- a/payment_method/model_get_all_payment_methods_default_response.go +++ b/payment_method/model_get_all_payment_methods_default_response.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter.go b/payment_method/model_over_the_counter.go index 8b1f61e4..06f11a01 100644 --- a/payment_method/model_over_the_counter.go +++ b/payment_method/model_over_the_counter.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter_channel_code.go b/payment_method/model_over_the_counter_channel_code.go index 24b6bfb6..6dc7690e 100644 --- a/payment_method/model_over_the_counter_channel_code.go +++ b/payment_method/model_over_the_counter_channel_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter_channel_properties.go b/payment_method/model_over_the_counter_channel_properties.go index 9d5c0b0b..0c6fa7b9 100644 --- a/payment_method/model_over_the_counter_channel_properties.go +++ b/payment_method/model_over_the_counter_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter_channel_properties_update.go b/payment_method/model_over_the_counter_channel_properties_update.go index 9837dbf3..059333b8 100644 --- a/payment_method/model_over_the_counter_channel_properties_update.go +++ b/payment_method/model_over_the_counter_channel_properties_update.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter_parameters.go b/payment_method/model_over_the_counter_parameters.go index 041d20fc..1c865263 100644 --- a/payment_method/model_over_the_counter_parameters.go +++ b/payment_method/model_over_the_counter_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_over_the_counter_update_parameters.go b/payment_method/model_over_the_counter_update_parameters.go index bb904c82..73eefd7b 100644 --- a/payment_method/model_over_the_counter_update_parameters.go +++ b/payment_method/model_over_the_counter_update_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method.go b/payment_method/model_payment_method.go index 42f99c50..d941e1fe 100644 --- a/payment_method/model_payment_method.go +++ b/payment_method/model_payment_method.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_action.go b/payment_method/model_payment_method_action.go index feb22f66..e393770f 100644 --- a/payment_method/model_payment_method_action.go +++ b/payment_method/model_payment_method_action.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_auth_parameters.go b/payment_method/model_payment_method_auth_parameters.go index f75951e9..eaace710 100644 --- a/payment_method/model_payment_method_auth_parameters.go +++ b/payment_method/model_payment_method_auth_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_country.go b/payment_method/model_payment_method_country.go index 40086ac5..99b346e6 100644 --- a/payment_method/model_payment_method_country.go +++ b/payment_method/model_payment_method_country.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ @@ -25,6 +25,7 @@ const ( PAYMENTMETHODCOUNTRY_VN PaymentMethodCountry = "VN" PAYMENTMETHODCOUNTRY_TH PaymentMethodCountry = "TH" PAYMENTMETHODCOUNTRY_MY PaymentMethodCountry = "MY" + PAYMENTMETHODCOUNTRY_US PaymentMethodCountry = "US" PAYMENTMETHODCOUNTRY_XENDIT_ENUM_DEFAULT_FALLBACK PaymentMethodCountry = "UNKNOWN_ENUM_VALUE" ) @@ -35,6 +36,7 @@ var AllowedPaymentMethodCountryEnumValues = []PaymentMethodCountry{ "VN", "TH", "MY", + "US", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_method/model_payment_method_expire_parameters.go b/payment_method/model_payment_method_expire_parameters.go index 57f3d586..415951d3 100644 --- a/payment_method/model_payment_method_expire_parameters.go +++ b/payment_method/model_payment_method_expire_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_list.go b/payment_method/model_payment_method_list.go index df572c66..8e17b349 100644 --- a/payment_method/model_payment_method_list.go +++ b/payment_method/model_payment_method_list.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_parameters.go b/payment_method/model_payment_method_parameters.go index 0a86697a..b93e0e80 100644 --- a/payment_method/model_payment_method_parameters.go +++ b/payment_method/model_payment_method_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_reusability.go b/payment_method/model_payment_method_reusability.go index 1f68b919..104f101d 100644 --- a/payment_method/model_payment_method_reusability.go +++ b/payment_method/model_payment_method_reusability.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_status.go b/payment_method/model_payment_method_status.go index 70bd1aa6..616ce6f8 100644 --- a/payment_method/model_payment_method_status.go +++ b/payment_method/model_payment_method_status.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_type.go b/payment_method/model_payment_method_type.go index f68e60c5..34414526 100644 --- a/payment_method/model_payment_method_type.go +++ b/payment_method/model_payment_method_type.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_payment_method_update_parameters.go b/payment_method/model_payment_method_update_parameters.go index d445d340..9ce28c2f 100644 --- a/payment_method/model_payment_method_update_parameters.go +++ b/payment_method/model_payment_method_update_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_qr_code.go b/payment_method/model_qr_code.go index b8cba059..9c3bbd8e 100644 --- a/payment_method/model_qr_code.go +++ b/payment_method/model_qr_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_qr_code_channel_code.go b/payment_method/model_qr_code_channel_code.go index 0d8fcbcd..5a466e60 100644 --- a/payment_method/model_qr_code_channel_code.go +++ b/payment_method/model_qr_code_channel_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_qr_code_channel_properties.go b/payment_method/model_qr_code_channel_properties.go index d05ee4d7..7a190c18 100644 --- a/payment_method/model_qr_code_channel_properties.go +++ b/payment_method/model_qr_code_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_qr_code_parameters.go b/payment_method/model_qr_code_parameters.go index 54f19940..b660ba04 100644 --- a/payment_method/model_qr_code_parameters.go +++ b/payment_method/model_qr_code_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_simulate_payment_request.go b/payment_method/model_simulate_payment_request.go index 47c134cd..2a663318 100644 --- a/payment_method/model_simulate_payment_request.go +++ b/payment_method/model_simulate_payment_request.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_tokenized_card_information.go b/payment_method/model_tokenized_card_information.go index 3221bca8..13ddf5aa 100644 --- a/payment_method/model_tokenized_card_information.go +++ b/payment_method/model_tokenized_card_information.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account.go b/payment_method/model_virtual_account.go index d0982eb0..2cbdc293 100644 --- a/payment_method/model_virtual_account.go +++ b/payment_method/model_virtual_account.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_all_of.go b/payment_method/model_virtual_account_all_of.go index 02f486f5..7d66542c 100644 --- a/payment_method/model_virtual_account_all_of.go +++ b/payment_method/model_virtual_account_all_of.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_alternative_display.go b/payment_method/model_virtual_account_alternative_display.go index 68451f6d..9bd0a6fa 100644 --- a/payment_method/model_virtual_account_alternative_display.go +++ b/payment_method/model_virtual_account_alternative_display.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_channel_code.go b/payment_method/model_virtual_account_channel_code.go index 340cd99f..a60c9499 100644 --- a/payment_method/model_virtual_account_channel_code.go +++ b/payment_method/model_virtual_account_channel_code.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ @@ -35,6 +35,7 @@ const ( VIRTUALACCOUNTCHANNELCODE_WOORI VirtualAccountChannelCode = "WOORI" VIRTUALACCOUNTCHANNELCODE_MSB VirtualAccountChannelCode = "MSB" VIRTUALACCOUNTCHANNELCODE_STANDARD_CHARTERED VirtualAccountChannelCode = "STANDARD_CHARTERED" + VIRTUALACCOUNTCHANNELCODE_AMBANK VirtualAccountChannelCode = "AMBANK" VIRTUALACCOUNTCHANNELCODE_XENDIT_ENUM_DEFAULT_FALLBACK VirtualAccountChannelCode = "UNKNOWN_ENUM_VALUE" ) @@ -55,6 +56,7 @@ var AllowedVirtualAccountChannelCodeEnumValues = []VirtualAccountChannelCode{ "WOORI", "MSB", "STANDARD_CHARTERED", + "AMBANK", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_method/model_virtual_account_channel_properties.go b/payment_method/model_virtual_account_channel_properties.go index 2234041c..88a985fa 100644 --- a/payment_method/model_virtual_account_channel_properties.go +++ b/payment_method/model_virtual_account_channel_properties.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_channel_properties_patch.go b/payment_method/model_virtual_account_channel_properties_patch.go index 1baf75f3..16d06edc 100644 --- a/payment_method/model_virtual_account_channel_properties_patch.go +++ b/payment_method/model_virtual_account_channel_properties_patch.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_parameters.go b/payment_method/model_virtual_account_parameters.go index 71cffe47..898f25b3 100644 --- a/payment_method/model_virtual_account_parameters.go +++ b/payment_method/model_virtual_account_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_method/model_virtual_account_update_parameters.go b/payment_method/model_virtual_account_update_parameters.go index 0919ed70..af1bc64b 100644 --- a/payment_method/model_virtual_account_update_parameters.go +++ b/payment_method/model_virtual_account_update_parameters.go @@ -3,7 +3,7 @@ Payment Method Service v2 This API is used for Payment Method Service v2 -API version: 2.89.2 +API version: 2.91.2 */ diff --git a/payment_request/model_capture.go b/payment_request/model_capture.go index c6dca18b..c0bd09cc 100644 --- a/payment_request/model_capture.go +++ b/payment_request/model_capture.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_capture_list_response.go b/payment_request/model_capture_list_response.go index c43e03ba..14bd156c 100644 --- a/payment_request/model_capture_list_response.go +++ b/payment_request/model_capture_list_response.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_capture_parameters.go b/payment_request/model_capture_parameters.go index 7ac835ad..c0d71d17 100644 --- a/payment_request/model_capture_parameters.go +++ b/payment_request/model_capture_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_card.go b/payment_request/model_card.go index 5f4e42ff..56ea91f3 100644 --- a/payment_request/model_card.go +++ b/payment_request/model_card.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_card_channel_properties.go b/payment_request/model_card_channel_properties.go index 14f5fbb9..5c42a440 100644 --- a/payment_request/model_card_channel_properties.go +++ b/payment_request/model_card_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_card_information.go b/payment_request/model_card_information.go index b8f2e212..83abf71e 100644 --- a/payment_request/model_card_information.go +++ b/payment_request/model_card_information.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_card_verification_results.go b/payment_request/model_card_verification_results.go index 57a958b4..9cd56d69 100644 --- a/payment_request/model_card_verification_results.go +++ b/payment_request/model_card_verification_results.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_card_verification_results_three_d_secure.go b/payment_request/model_card_verification_results_three_d_secure.go index c48d30b4..6063cdbb 100644 --- a/payment_request/model_card_verification_results_three_d_secure.go +++ b/payment_request/model_card_verification_results_three_d_secure.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit.go b/payment_request/model_direct_debit.go index 128d527d..409985fa 100644 --- a/payment_request/model_direct_debit.go +++ b/payment_request/model_direct_debit.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_all_of.go b/payment_request/model_direct_debit_all_of.go index 2c08711e..79fec0d5 100644 --- a/payment_request/model_direct_debit_all_of.go +++ b/payment_request/model_direct_debit_all_of.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_bank_account.go b/payment_request/model_direct_debit_bank_account.go index 76064e57..8178e3e5 100644 --- a/payment_request/model_direct_debit_bank_account.go +++ b/payment_request/model_direct_debit_bank_account.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_channel_code.go b/payment_request/model_direct_debit_channel_code.go index 9384e0da..c807444d 100644 --- a/payment_request/model_direct_debit_channel_code.go +++ b/payment_request/model_direct_debit_channel_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_channel_properties.go b/payment_request/model_direct_debit_channel_properties.go index 5657a5ef..41ca02b8 100644 --- a/payment_request/model_direct_debit_channel_properties.go +++ b/payment_request/model_direct_debit_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_channel_properties_bank_account.go b/payment_request/model_direct_debit_channel_properties_bank_account.go index 79477d6d..bef8ba52 100644 --- a/payment_request/model_direct_debit_channel_properties_bank_account.go +++ b/payment_request/model_direct_debit_channel_properties_bank_account.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_channel_properties_bank_redirect.go b/payment_request/model_direct_debit_channel_properties_bank_redirect.go index ba3194f2..c441d55f 100644 --- a/payment_request/model_direct_debit_channel_properties_bank_redirect.go +++ b/payment_request/model_direct_debit_channel_properties_bank_redirect.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_channel_properties_debit_card.go b/payment_request/model_direct_debit_channel_properties_debit_card.go index 1efb5284..c060b37a 100644 --- a/payment_request/model_direct_debit_channel_properties_debit_card.go +++ b/payment_request/model_direct_debit_channel_properties_debit_card.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_debit_card.go b/payment_request/model_direct_debit_debit_card.go index 041d3147..1e5d67a8 100644 --- a/payment_request/model_direct_debit_debit_card.go +++ b/payment_request/model_direct_debit_debit_card.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_parameters.go b/payment_request/model_direct_debit_parameters.go index 7e42465b..3e45efcb 100644 --- a/payment_request/model_direct_debit_parameters.go +++ b/payment_request/model_direct_debit_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_direct_debit_type.go b/payment_request/model_direct_debit_type.go index 9ac26706..6baee2ff 100644 --- a/payment_request/model_direct_debit_type.go +++ b/payment_request/model_direct_debit_type.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_e_wallet.go b/payment_request/model_e_wallet.go index ed713322..441f87dc 100644 --- a/payment_request/model_e_wallet.go +++ b/payment_request/model_e_wallet.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_e_wallet_account.go b/payment_request/model_e_wallet_account.go index 4de4c438..dc90569e 100644 --- a/payment_request/model_e_wallet_account.go +++ b/payment_request/model_e_wallet_account.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_e_wallet_all_of.go b/payment_request/model_e_wallet_all_of.go index c4b27ee2..86b58c8c 100644 --- a/payment_request/model_e_wallet_all_of.go +++ b/payment_request/model_e_wallet_all_of.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_e_wallet_channel_code.go b/payment_request/model_e_wallet_channel_code.go index 2a7d8893..950f07e3 100644 --- a/payment_request/model_e_wallet_channel_code.go +++ b/payment_request/model_e_wallet_channel_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ @@ -39,6 +39,7 @@ const ( EWALLETCHANNELCODE_LINEPAY EWalletChannelCode = "LINEPAY" EWALLETCHANNELCODE_TRUEMONEY EWalletChannelCode = "TRUEMONEY" EWALLETCHANNELCODE_ALIPAY EWalletChannelCode = "ALIPAY" + EWALLETCHANNELCODE_TOUCHANDGO EWalletChannelCode = "TOUCHANDGO" EWALLETCHANNELCODE_XENDIT_ENUM_DEFAULT_FALLBACK EWalletChannelCode = "UNKNOWN_ENUM_VALUE" ) @@ -63,6 +64,7 @@ var AllowedEWalletChannelCodeEnumValues = []EWalletChannelCode{ "LINEPAY", "TRUEMONEY", "ALIPAY", + "TOUCHANDGO", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_request/model_e_wallet_channel_properties.go b/payment_request/model_e_wallet_channel_properties.go index 86519f12..fd664137 100644 --- a/payment_request/model_e_wallet_channel_properties.go +++ b/payment_request/model_e_wallet_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_e_wallet_parameters.go b/payment_request/model_e_wallet_parameters.go index 25878218..e6a8a3e8 100644 --- a/payment_request/model_e_wallet_parameters.go +++ b/payment_request/model_e_wallet_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_error.go b/payment_request/model_error.go index 226769e2..874ed476 100644 --- a/payment_request/model_error.go +++ b/payment_request/model_error.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_over_the_counter.go b/payment_request/model_over_the_counter.go index 0324df1c..d89b1ee8 100644 --- a/payment_request/model_over_the_counter.go +++ b/payment_request/model_over_the_counter.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_over_the_counter_channel_code.go b/payment_request/model_over_the_counter_channel_code.go index 8b7c9160..2665a93d 100644 --- a/payment_request/model_over_the_counter_channel_code.go +++ b/payment_request/model_over_the_counter_channel_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_over_the_counter_channel_properties.go b/payment_request/model_over_the_counter_channel_properties.go index 2e7d6e52..52d8c33e 100644 --- a/payment_request/model_over_the_counter_channel_properties.go +++ b/payment_request/model_over_the_counter_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_over_the_counter_parameters.go b/payment_request/model_over_the_counter_parameters.go index a27f5764..18c1973a 100644 --- a/payment_request/model_over_the_counter_parameters.go +++ b/payment_request/model_over_the_counter_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_method.go b/payment_request/model_payment_method.go index 6cb9d63c..d982587d 100644 --- a/payment_request/model_payment_method.go +++ b/payment_request/model_payment_method.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_method_parameters.go b/payment_request/model_payment_method_parameters.go index e7f26c2a..1611fefa 100644 --- a/payment_request/model_payment_method_parameters.go +++ b/payment_request/model_payment_method_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_method_reusability.go b/payment_request/model_payment_method_reusability.go index a0a28e32..9b6ae93c 100644 --- a/payment_request/model_payment_method_reusability.go +++ b/payment_request/model_payment_method_reusability.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_method_status.go b/payment_request/model_payment_method_status.go index c4158549..56551569 100644 --- a/payment_request/model_payment_method_status.go +++ b/payment_request/model_payment_method_status.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_method_type.go b/payment_request/model_payment_method_type.go index e72cb9f2..08ed3712 100644 --- a/payment_request/model_payment_method_type.go +++ b/payment_request/model_payment_method_type.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request.go b/payment_request/model_payment_request.go index c4f3464a..4e8a4c92 100644 --- a/payment_request/model_payment_request.go +++ b/payment_request/model_payment_request.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_action.go b/payment_request/model_payment_request_action.go index e0110fe2..98ce302a 100644 --- a/payment_request/model_payment_request_action.go +++ b/payment_request/model_payment_request_action.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_auth_parameters.go b/payment_request/model_payment_request_auth_parameters.go index a6c4346e..cc6d7dd9 100644 --- a/payment_request/model_payment_request_auth_parameters.go +++ b/payment_request/model_payment_request_auth_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_basket_item.go b/payment_request/model_payment_request_basket_item.go index a2808037..5cb982c8 100644 --- a/payment_request/model_payment_request_basket_item.go +++ b/payment_request/model_payment_request_basket_item.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_capture_method.go b/payment_request/model_payment_request_capture_method.go index 732f0b79..26d64694 100644 --- a/payment_request/model_payment_request_capture_method.go +++ b/payment_request/model_payment_request_capture_method.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_card_verification_results.go b/payment_request/model_payment_request_card_verification_results.go index 1ab68c13..eb8324af 100644 --- a/payment_request/model_payment_request_card_verification_results.go +++ b/payment_request/model_payment_request_card_verification_results.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_card_verification_results_three_dee_secure.go b/payment_request/model_payment_request_card_verification_results_three_dee_secure.go index 4513cefc..2ebf1267 100644 --- a/payment_request/model_payment_request_card_verification_results_three_dee_secure.go +++ b/payment_request/model_payment_request_card_verification_results_three_dee_secure.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_channel_properties.go b/payment_request/model_payment_request_channel_properties.go index dde1dd2b..ed1f18de 100644 --- a/payment_request/model_payment_request_channel_properties.go +++ b/payment_request/model_payment_request_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_country.go b/payment_request/model_payment_request_country.go index 78b25fba..7cf177d9 100644 --- a/payment_request/model_payment_request_country.go +++ b/payment_request/model_payment_request_country.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_currency.go b/payment_request/model_payment_request_currency.go index 89421566..64c66440 100644 --- a/payment_request/model_payment_request_currency.go +++ b/payment_request/model_payment_request_currency.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ @@ -25,6 +25,7 @@ const ( PAYMENTREQUESTCURRENCY_VND PaymentRequestCurrency = "VND" PAYMENTREQUESTCURRENCY_THB PaymentRequestCurrency = "THB" PAYMENTREQUESTCURRENCY_MYR PaymentRequestCurrency = "MYR" + PAYMENTREQUESTCURRENCY_USD PaymentRequestCurrency = "USD" PAYMENTREQUESTCURRENCY_XENDIT_ENUM_DEFAULT_FALLBACK PaymentRequestCurrency = "UNKNOWN_ENUM_VALUE" ) @@ -35,6 +36,7 @@ var AllowedPaymentRequestCurrencyEnumValues = []PaymentRequestCurrency{ "VND", "THB", "MYR", + "USD", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_request/model_payment_request_initiator.go b/payment_request/model_payment_request_initiator.go index 2102d4f5..38d730d0 100644 --- a/payment_request/model_payment_request_initiator.go +++ b/payment_request/model_payment_request_initiator.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_list_response.go b/payment_request/model_payment_request_list_response.go index 0c838b0d..af7c06ea 100644 --- a/payment_request/model_payment_request_list_response.go +++ b/payment_request/model_payment_request_list_response.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_parameters.go b/payment_request/model_payment_request_parameters.go index 2f196899..00c83097 100644 --- a/payment_request/model_payment_request_parameters.go +++ b/payment_request/model_payment_request_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_parameters_channel_properties.go b/payment_request/model_payment_request_parameters_channel_properties.go index 6d25f988..25f15ebe 100644 --- a/payment_request/model_payment_request_parameters_channel_properties.go +++ b/payment_request/model_payment_request_parameters_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_parameters_channel_properties_all_of.go b/payment_request/model_payment_request_parameters_channel_properties_all_of.go index ba12d478..a30d9125 100644 --- a/payment_request/model_payment_request_parameters_channel_properties_all_of.go +++ b/payment_request/model_payment_request_parameters_channel_properties_all_of.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_shipping_information.go b/payment_request/model_payment_request_shipping_information.go index 2efa6d1e..20ac023f 100644 --- a/payment_request/model_payment_request_shipping_information.go +++ b/payment_request/model_payment_request_shipping_information.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_payment_request_status.go b/payment_request/model_payment_request_status.go index dff8fdd9..28f9a80f 100644 --- a/payment_request/model_payment_request_status.go +++ b/payment_request/model_payment_request_status.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_qr_code.go b/payment_request/model_qr_code.go index 4b647e0d..78b7a071 100644 --- a/payment_request/model_qr_code.go +++ b/payment_request/model_qr_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_qr_code_channel_code.go b/payment_request/model_qr_code_channel_code.go index 02aa4ea3..6255ce8e 100644 --- a/payment_request/model_qr_code_channel_code.go +++ b/payment_request/model_qr_code_channel_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_qr_code_channel_properties.go b/payment_request/model_qr_code_channel_properties.go index 87396aea..6051d2ee 100644 --- a/payment_request/model_qr_code_channel_properties.go +++ b/payment_request/model_qr_code_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_qr_code_parameters.go b/payment_request/model_qr_code_parameters.go index 96b1bb70..bbe4f08e 100644 --- a/payment_request/model_qr_code_parameters.go +++ b/payment_request/model_qr_code_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_virtual_account.go b/payment_request/model_virtual_account.go index 87da1d11..9424a285 100644 --- a/payment_request/model_virtual_account.go +++ b/payment_request/model_virtual_account.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_virtual_account_all_of.go b/payment_request/model_virtual_account_all_of.go index 2ce625e7..d4da2434 100644 --- a/payment_request/model_virtual_account_all_of.go +++ b/payment_request/model_virtual_account_all_of.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_virtual_account_alternative_display.go b/payment_request/model_virtual_account_alternative_display.go index b5d320b8..9cbc45f6 100644 --- a/payment_request/model_virtual_account_alternative_display.go +++ b/payment_request/model_virtual_account_alternative_display.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_virtual_account_channel_code.go b/payment_request/model_virtual_account_channel_code.go index c45e26a4..ecd9da9e 100644 --- a/payment_request/model_virtual_account_channel_code.go +++ b/payment_request/model_virtual_account_channel_code.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ @@ -35,6 +35,7 @@ const ( VIRTUALACCOUNTCHANNELCODE_WOORI VirtualAccountChannelCode = "WOORI" VIRTUALACCOUNTCHANNELCODE_MSB VirtualAccountChannelCode = "MSB" VIRTUALACCOUNTCHANNELCODE_STANDARD_CHARTERED VirtualAccountChannelCode = "STANDARD_CHARTERED" + VIRTUALACCOUNTCHANNELCODE_AMBANK VirtualAccountChannelCode = "AMBANK" VIRTUALACCOUNTCHANNELCODE_XENDIT_ENUM_DEFAULT_FALLBACK VirtualAccountChannelCode = "UNKNOWN_ENUM_VALUE" ) @@ -55,6 +56,7 @@ var AllowedVirtualAccountChannelCodeEnumValues = []VirtualAccountChannelCode{ "WOORI", "MSB", "STANDARD_CHARTERED", + "AMBANK", "UNKNOWN_ENUM_VALUE", } diff --git a/payment_request/model_virtual_account_channel_properties.go b/payment_request/model_virtual_account_channel_properties.go index 3c9adf12..53d395c1 100644 --- a/payment_request/model_virtual_account_channel_properties.go +++ b/payment_request/model_virtual_account_channel_properties.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */ diff --git a/payment_request/model_virtual_account_parameters.go b/payment_request/model_virtual_account_parameters.go index 5f4726fe..ef396926 100644 --- a/payment_request/model_virtual_account_parameters.go +++ b/payment_request/model_virtual_account_parameters.go @@ -3,7 +3,7 @@ Payment Requests This API is used for Payment Requests -API version: 1.44.1 +API version: 1.45.1 */