Dynamic currency conversion markup in basis points. This value cannot be 0 if the dccForceCurrency field is empty.
Security
SecretApiKey or JWT
Enum:"A1Gateway""ACI""Adyen""Aera""Aircash""Airpay""Airwallex""AsiaPay""AmazonPay""AmexVPC"
Discriminator
Default:"Other"
Enum:"Adyen""ACI""Aera""Alipay""AIB""Aircash""Airpay""AmazonPay""ApcoPay""AsiaPaymentGateway"
Enum:"payment-card""ach""cash""check""paypal""AdvCash""Aera""Affirm""Afterpay""Aircash"
Default:"0000"
Forces Dynamic Currency Conversion (DCC) to the specified currency on each sale. To disable forced DCC, leave this field empty.
Specifies whether a confirmation step is required when dccForceCurrency is set.
Default:false
Default:false
Excluded Dynamic Currency Conversion (DCC) quote currencies.
Allotted time, in seconds, in which an offsite transaction must be approved before it is automatically abandoned.
Default:3600
Specifies that if a transaction is not reconciled within the reconciliationWindowTtl time, the transaction is marked as abandoned.
Default:false
Allotted time, in seconds, in which a reconciliation must occur before it is automatically abandoned.
Additional filters used to determine if the gateway account can be selected to process a transaction.
For example, the filter may place a maximum amount value on transaction. If a transaction exceeds this value, the gateway account is not used.
For more information see, Using filters.
Example:"amount:1..100;bin:411111,444433"
Specifies if all future payments by the customer's payment instrument are processed by this gateway account.
For more information, see Gateway routing.
Default:true
Creates zero, one, or more child transactions such as authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.
Default:"do-nothing"
| Enum Value | Description |
|---|---|
| authorize | Creates an |
| authorize-and-void | Creates an |
| sca | Uses Strong Customer Authentication (SCA) without an |
| do-nothing | Does nothing except return an approved |
Default:"none"
| Enum Value | Description |
|---|---|
| all | |
| covered-payout | |
| approved-payment | |
| none |
One of:
Payout method limits for payout request auto-allocation. Limits apply to auto-allocation only. Manual allocations are uncapped.
Validation is per currency. When multiple limit types contain an entry for the same currency, the following requirements apply:
minPerTransaction.amount < maxPerTransaction.amount.minPerTransaction.amount <= maxPerPeriod.amount.
Email address template used in place of a customer's real email address when sending transaction data to a processor. Use {{customerId}} as a placeholder for the customer's ID. When empty, the customer's real email address is used.
Example:"{{customerId}}@receipts.example.com"
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Default:{}
Example:
{ "foo": "bar" }
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/gateway-accounts/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/gateway-accounts/{id}
curl -i -X PATCH \
'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}' \
-H 'Content-Type: application/json' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE' \
-d '{
"gatewayName": "A1Gateway",
"acquirerName": "Other",
"method": "payment-card",
"acceptedCurrencies": [
"string"
],
"paymentCardSchemes": [
"Visa"
],
"merchantCategoryCode": "0000",
"dccMarkup": -10000,
"dccForceCurrency": "string",
"dccForceConfirmation": false,
"dccForceRounding": false,
"descriptor": "string",
"cityField": "string",
"excludedDccQuoteCurrencies": [
"string"
],
"monthlyLimit": 0,
"approvalWindowTtl": 3600,
"reconciliationWindowEnabled": false,
"reconciliationWindowTtl": 300,
"threeDSecure": false,
"dynamicDescriptor": false,
"digitalWallets": {
"applePay": {
"isEnabled": false,
"displayName": "Test merchant",
"country": "US"
},
"googlePay": {
"isEnabled": false,
"merchantName": "Test merchant",
"merchantOrigin": "www.example.com",
"country": "US"
}
},
"additionalFilters": "amount:1..100;bin:411111,444433",
"timeout": 10,
"sticky": true,
"setupInstruction": "authorize",
"readyToPayoutInstruction": "all",
"payoutLimits": {
"maxPerTransaction": [
{
"amount": 3000,
"currency": "CAD"
}
],
"minPerTransaction": [
{
"amount": 100,
"currency": "CAD"
}
],
"maxPerPeriod": [
{
"amount": 10000,
"currency": "CAD",
"period": "24-hours"
}
]
},
"transactionEmailAliasTemplate": "{{customerId}}@receipts.example.com",
"customFields": {
"foo": "bar"
},
"credentials": {
"accountId": "string",
"password": "pa$$word"
}
}'Headers
Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.
Example:500
Number of requests still available for this rate limit. For more information, see Rate limits.
Example:499
Example:"gw_acc_0YVCXMF26DDNKAERE5NW727S34"
Enum:"A1Gateway""ACI""Adyen""Aera""Aircash""Airpay""Airwallex""AsiaPay""AmazonPay""AmexVPC"
Discriminator
Default:"Other"
Enum:"Adyen""ACI""Aera""Alipay""AIB""Aircash""Airpay""AmazonPay""ApcoPay""AsiaPaymentGateway"
Enum:"payment-card""ach""cash""check""paypal""AdvCash""Aera""Affirm""Afterpay""Aircash"
Default:"0000"
Dynamic currency conversion markup in basis points. This value cannot be 0 if the dccForceCurrency field is empty.
Forces Dynamic Currency Conversion (DCC) to the specified currency on each sale. To disable forced DCC, leave this field empty.
Specifies whether a confirmation step is required when dccForceCurrency is set.
Default:false
Default:false
Excluded Dynamic Currency Conversion (DCC) quote currencies.
Allotted time, in seconds, in which an offsite transaction must be approved before it is automatically abandoned.
Default:3600
Specifies that if a transaction is not reconciled within the reconciliationWindowTtl time, the transaction is marked as abandoned.
Default:false
Allotted time, in seconds, in which a reconciliation must occur before it is automatically abandoned.
Additional filters used to determine if the gateway account can be selected to process a transaction.
For example, the filter may place a maximum amount value on transaction. If a transaction exceeds this value, the gateway account is not used.
For more information see, Using filters.
Example:"amount:1..100;bin:411111,444433"
Specifies if all future payments by the customer's payment instrument are processed by this gateway account.
For more information, see Gateway routing.
Default:true
Creates zero, one, or more child transactions such as authorize and void. The transactions are linked to the setup transaction by the parentTransactionId relationship.
Default:"do-nothing"
| Enum Value | Description |
|---|---|
| authorize | Creates an |
| authorize-and-void | Creates an |
| sca | Uses Strong Customer Authentication (SCA) without an |
| do-nothing | Does nothing except return an approved |
Default:"none"
| Enum Value | Description |
|---|---|
| all | |
| covered-payout | |
| approved-payment | |
| none |
One of:
Payout method limits for payout request auto-allocation. Limits apply to auto-allocation only. Manual allocations are uncapped.
Validation is per currency. When multiple limit types contain an entry for the same currency, the following requirements apply:
minPerTransaction.amount < maxPerTransaction.amount.minPerTransaction.amount <= maxPerPeriod.amount.
Email address template used in place of a customer's real email address when sending transaction data to a processor. Use {{customerId}} as a placeholder for the customer's ID. When empty, the customer's real email address is used.
Example:"{{customerId}}@receipts.example.com"
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Default:{}
Example:
{ "foo": "bar" }
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
Response
{ "id": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayName": "A1Gateway", "acquirerName": "Other", "method": "payment-card", "acceptedCurrencies": [ "string" ], "paymentCardSchemes": [ "Visa" ], "status": "active", "merchantCategoryCode": "0000", "dccMarkup": -10000, "dccForceCurrency": "string", "dccForceConfirmation": false, "dccForceRounding": false, "descriptor": "string", "cityField": "string", "excludedDccQuoteCurrencies": [ "string" ], "monthlyLimit": 0, "approvalWindowTtl": 3600, "reconciliationWindowEnabled": false, "reconciliationWindowTtl": 300, "threeDSecure": false, "dynamicDescriptor": false, "digitalWallets": { "applePay": { … }, "googlePay": { … } }, "isDown": true, "additionalFilters": "amount:1..100;bin:411111,444433", "timeout": 10, "token": "TwiX3f92k4AiBE27BzTbQ38hHjicBz_w", "sticky": true, "setupInstruction": "authorize", "readyToPayoutInstruction": "all", "payoutLimits": { "maxPerTransaction": [ … ], "minPerTransaction": [ … ], "maxPerPeriod": [ … ] }, "transactionEmailAliasTemplate": "{{customerId}}@receipts.example.com", "customFields": { "foo": "bar" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "_links": [ { … } ], "credentials": { "accountId": "string" } }