@flowio/api-mock-generator 6.17.75 → 6.17.77
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.json +269 -555
- package/package.json +2 -2
- package/src/api.json +269 -555
package/dist/api.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"key": "api"
|
|
11
11
|
},
|
|
12
12
|
"namespace": "io.flow.v0",
|
|
13
|
-
"version": "0.18.
|
|
13
|
+
"version": "0.18.46",
|
|
14
14
|
"info": {
|
|
15
15
|
"license": {
|
|
16
16
|
"name": "MIT",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"application": {
|
|
32
32
|
"key": "apple-pay"
|
|
33
33
|
},
|
|
34
|
-
"version": "0.3.
|
|
34
|
+
"version": "0.3.46",
|
|
35
35
|
"enums": ["apple_pay_contact_field", "apple_pay_line_item_type", "apple_pay_merchant_capability", "apple_pay_shipping_type", "apple_pay_supported_networks"],
|
|
36
36
|
"interfaces": [],
|
|
37
37
|
"unions": [],
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"application": {
|
|
47
47
|
"key": "google-pay"
|
|
48
48
|
},
|
|
49
|
-
"version": "0.3.
|
|
49
|
+
"version": "0.3.46",
|
|
50
50
|
"enums": ["auth_method", "billing_address_format", "card_gateway", "card_network", "payment_method_type", "tokenization_type", "total_price_status"],
|
|
51
51
|
"interfaces": [],
|
|
52
52
|
"unions": ["payment_method_token"],
|
|
@@ -61,11 +61,11 @@
|
|
|
61
61
|
"application": {
|
|
62
62
|
"key": "shopify-external"
|
|
63
63
|
},
|
|
64
|
-
"version": "0.3.
|
|
65
|
-
"enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "inventory_behaviour", "inventory_management", "inventory_policy", "kind_type", "localized_price", "order_status_type", "price_rule_allocation_method", "price_rule_customer_selection", "price_rule_target_selection", "price_rule_target_type", "price_rule_value_type", "published_scope", "restock_type", "shopify_customer_state", "shopify_discount_pagination_direction", "shopify_gift_card_status", "shopify_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
|
|
64
|
+
"version": "0.3.46",
|
|
65
|
+
"enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "inventory_behaviour", "inventory_management", "inventory_policy", "kind_type", "localized_price", "order_status_type", "price_rule_allocation_method", "price_rule_customer_selection", "price_rule_target_selection", "price_rule_target_type", "price_rule_value_type", "published_scope", "restock_type", "shopify_customer_state", "shopify_discount_pagination_direction", "shopify_gift_card_status", "shopify_plan_name", "shopify_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
|
|
66
66
|
"interfaces": [],
|
|
67
67
|
"unions": [],
|
|
68
|
-
"models": ["collection", "collection_webhook", "count", "metafield", "metafield_form", "option", "price_rule", "price_rule_discount_code", "price_rule_form", "price_rule_greater_than_range", "price_rule_less_than_range", "price_rule_prerequisite_to_entitlement_purchase", "price_rule_prerequisite_to_entitlement_quantity_ratio", "product", "product_delete", "product_image", "product_variant", "request_metafield_form", "request_shopify_gift_card", "request_shopify_refund_form", "request_shopify_transaction_form", "response_collection", "response_metafield", "response_metafields", "response_orders_wrapper", "response_price_rule", "response_price_rule_discount_code", "response_price_rule_discount_codes", "response_price_rules", "response_product", "response_products", "response_shopify_gift_card", "response_shopify_gift_cards", "response_shopify_refund_single", "response_shopify_transaction", "response_shopify_transaction_single", "response_smart_collection", "response_variant", "shop", "shop_response", "shopify_address", "shopify_attribute", "shopify_cart_item_discount", "shopify_client_detail", "shopify_customer", "shopify_customer_address", "shopify_customer_delete", "shopify_customers_response_wrapper", "shopify_discount_application", "shopify_discount_code", "shopify_error", "shopify_external_cart", "shopify_external_cart_item", "shopify_fulfillment", "shopify_fulfillment_wrapper", "shopify_gift_card", "shopify_gift_card_adjustment", "shopify_gift_card_adjustment_form", "shopify_gift_card_adjustment_form_wrapper", "shopify_gift_card_adjustment_response_wrapper", "shopify_gift_card_adjustments_response_wrapper", "shopify_gift_card_form", "shopify_inventory_item", "shopify_inventory_item_delete", "shopify_inventory_level", "shopify_inventory_level_disconnect", "shopify_inventory_level_response_wrapper", "shopify_line_item", "shopify_line_item_form", "shopify_line_level_discount_allocation", "shopify_location", "shopify_location_delete", "shopify_locations_response_wrapper", "shopify_order", "shopify_order_count", "shopify_order_customer", "shopify_order_wrapper", "shopify_payment_detail", "shopify_property", "shopify_refund", "shopify_refund_form", "shopify_refund_line_item", "shopify_refund_line_item_form", "shopify_shipping_line", "shopify_tax_line", "shopify_transaction", "shopify_transaction_form", "shopify_transaction_gift_card_receipt", "shopify_webhook_customers_redact", "shopify_webhook_customers_redact_customer", "shopify_webhook_order", "shopify_webhook_order_cancelled", "shopify_webhook_order_line_item", "shopify_webhook_shop_redact", "smart_collection", "webhook", "webhook_form", "webhook_form_wrapper", "webhook_response_list", "webhook_response_single"],
|
|
68
|
+
"models": ["collection", "collection_webhook", "count", "metafield", "metafield_form", "option", "price_rule", "price_rule_discount_code", "price_rule_form", "price_rule_greater_than_range", "price_rule_less_than_range", "price_rule_prerequisite_to_entitlement_purchase", "price_rule_prerequisite_to_entitlement_quantity_ratio", "product", "product_delete", "product_image", "product_variant", "request_metafield_form", "request_shopify_gift_card", "request_shopify_refund_form", "request_shopify_transaction_form", "response_collection", "response_metafield", "response_metafields", "response_orders_wrapper", "response_price_rule", "response_price_rule_discount_code", "response_price_rule_discount_codes", "response_price_rules", "response_product", "response_products", "response_shopify_gift_card", "response_shopify_gift_cards", "response_shopify_refund_single", "response_shopify_transaction", "response_shopify_transaction_single", "response_smart_collection", "response_variant", "shop", "shop_response", "shopify_address", "shopify_attribute", "shopify_cart_item_discount", "shopify_client_detail", "shopify_customer", "shopify_customer_address", "shopify_customer_delete", "shopify_customers_response_wrapper", "shopify_discount_application", "shopify_discount_code", "shopify_error", "shopify_external_cart", "shopify_external_cart_item", "shopify_fulfillment", "shopify_fulfillment_wrapper", "shopify_gift_card", "shopify_gift_card_adjustment", "shopify_gift_card_adjustment_form", "shopify_gift_card_adjustment_form_wrapper", "shopify_gift_card_adjustment_response_wrapper", "shopify_gift_card_adjustments_response_wrapper", "shopify_gift_card_form", "shopify_inventory_item", "shopify_inventory_item_delete", "shopify_inventory_level", "shopify_inventory_level_disconnect", "shopify_inventory_level_response_wrapper", "shopify_line_item", "shopify_line_item_form", "shopify_line_level_discount_allocation", "shopify_location", "shopify_location_delete", "shopify_locations_response_wrapper", "shopify_order", "shopify_order_count", "shopify_order_customer", "shopify_order_wrapper", "shopify_payment_detail", "shopify_property", "shopify_refund", "shopify_refund_form", "shopify_refund_line_item", "shopify_refund_line_item_form", "shopify_shipping_line", "shopify_shop_update", "shopify_tax_line", "shopify_transaction", "shopify_transaction_form", "shopify_transaction_gift_card_receipt", "shopify_webhook_customers_redact", "shopify_webhook_customers_redact_customer", "shopify_webhook_order", "shopify_webhook_order_cancelled", "shopify_webhook_order_line_item", "shopify_webhook_shop_redact", "smart_collection", "webhook", "webhook_form", "webhook_form_wrapper", "webhook_response_list", "webhook_response_single"],
|
|
69
69
|
"annotations": []
|
|
70
70
|
}, {
|
|
71
71
|
"uri": "https://app.apibuilder.io/flow/ben-test-internal/latest/service.json",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"application": {
|
|
77
77
|
"key": "ben-test-internal"
|
|
78
78
|
},
|
|
79
|
-
"version": "0.
|
|
79
|
+
"version": "0.22.20",
|
|
80
80
|
"enums": [],
|
|
81
81
|
"interfaces": ["generate_load"],
|
|
82
82
|
"unions": ["generate_load"],
|
|
@@ -5096,6 +5096,9 @@
|
|
|
5096
5096
|
}, {
|
|
5097
5097
|
"name": "carrier_charge_revenue_share",
|
|
5098
5098
|
"attributes": []
|
|
5099
|
+
}, {
|
|
5100
|
+
"name": "carrier_fee",
|
|
5101
|
+
"attributes": []
|
|
5099
5102
|
}, {
|
|
5100
5103
|
"name": "platform_fee",
|
|
5101
5104
|
"attributes": []
|
|
@@ -9495,11 +9498,21 @@
|
|
|
9495
9498
|
"attributes": [],
|
|
9496
9499
|
"default": false,
|
|
9497
9500
|
"discriminator_value": "carrier_charge"
|
|
9501
|
+
}, {
|
|
9502
|
+
"type": "transaction_metadata_carrier_fee",
|
|
9503
|
+
"attributes": [],
|
|
9504
|
+
"default": false,
|
|
9505
|
+
"discriminator_value": "carrier_fee"
|
|
9498
9506
|
}, {
|
|
9499
9507
|
"type": "transaction_metadata_manual",
|
|
9500
9508
|
"attributes": [],
|
|
9501
9509
|
"default": false,
|
|
9502
9510
|
"discriminator_value": "manual"
|
|
9511
|
+
}, {
|
|
9512
|
+
"type": "transaction_metadata_payment_transaction",
|
|
9513
|
+
"attributes": [],
|
|
9514
|
+
"default": false,
|
|
9515
|
+
"discriminator_value": "payment_transaction"
|
|
9503
9516
|
}],
|
|
9504
9517
|
"attributes": [],
|
|
9505
9518
|
"interfaces": [],
|
|
@@ -19713,6 +19726,12 @@
|
|
|
19713
19726
|
"required": true,
|
|
19714
19727
|
"attributes": [],
|
|
19715
19728
|
"annotations": []
|
|
19729
|
+
}, {
|
|
19730
|
+
"name": "deactivate_at",
|
|
19731
|
+
"type": "date-time-iso8601",
|
|
19732
|
+
"required": false,
|
|
19733
|
+
"attributes": [],
|
|
19734
|
+
"annotations": []
|
|
19716
19735
|
}],
|
|
19717
19736
|
"attributes": [],
|
|
19718
19737
|
"interfaces": []
|
|
@@ -31128,6 +31147,12 @@
|
|
|
31128
31147
|
"required": true,
|
|
31129
31148
|
"attributes": [],
|
|
31130
31149
|
"annotations": []
|
|
31150
|
+
}, {
|
|
31151
|
+
"name": "deactivate_at",
|
|
31152
|
+
"type": "date-time-iso8601",
|
|
31153
|
+
"required": false,
|
|
31154
|
+
"attributes": [],
|
|
31155
|
+
"annotations": []
|
|
31131
31156
|
}],
|
|
31132
31157
|
"attributes": [],
|
|
31133
31158
|
"interfaces": [],
|
|
@@ -37258,6 +37283,13 @@
|
|
|
37258
37283
|
"annotations": [],
|
|
37259
37284
|
"description": "The ISO 4217-3 code for the base currency.",
|
|
37260
37285
|
"example": "CAD"
|
|
37286
|
+
}, {
|
|
37287
|
+
"name": "reference",
|
|
37288
|
+
"type": "string",
|
|
37289
|
+
"required": false,
|
|
37290
|
+
"attributes": [],
|
|
37291
|
+
"annotations": [],
|
|
37292
|
+
"description": "Custom payment identifier"
|
|
37261
37293
|
}],
|
|
37262
37294
|
"attributes": [],
|
|
37263
37295
|
"interfaces": [],
|
|
@@ -37322,6 +37354,13 @@
|
|
|
37322
37354
|
"annotations": [],
|
|
37323
37355
|
"description": "The ISO 4217-3 code for the base currency.",
|
|
37324
37356
|
"example": "CAD"
|
|
37357
|
+
}, {
|
|
37358
|
+
"name": "reference",
|
|
37359
|
+
"type": "string",
|
|
37360
|
+
"required": false,
|
|
37361
|
+
"attributes": [],
|
|
37362
|
+
"annotations": [],
|
|
37363
|
+
"description": "Externally provided identifier at the atomic action level"
|
|
37325
37364
|
}, {
|
|
37326
37365
|
"name": "created_at",
|
|
37327
37366
|
"type": "date-time-iso8601",
|
|
@@ -37363,6 +37402,13 @@
|
|
|
37363
37402
|
"annotations": [],
|
|
37364
37403
|
"description": "Required if amount is specified. The ISO 4217-3 code for the currency. Case insensitive. See https://api.flow.io/reference/currencies",
|
|
37365
37404
|
"example": "CAD"
|
|
37405
|
+
}, {
|
|
37406
|
+
"name": "reference",
|
|
37407
|
+
"type": "string",
|
|
37408
|
+
"required": false,
|
|
37409
|
+
"attributes": [],
|
|
37410
|
+
"annotations": [],
|
|
37411
|
+
"description": "Externally provided identifier at the atomic action level"
|
|
37366
37412
|
}, {
|
|
37367
37413
|
"name": "attributes",
|
|
37368
37414
|
"type": "map[string]",
|
|
@@ -37724,7 +37770,7 @@
|
|
|
37724
37770
|
"attributes": [],
|
|
37725
37771
|
"annotations": [],
|
|
37726
37772
|
"description": "The date before which this payment request can be captured. After that date, it is likely that the capture will fail.",
|
|
37727
|
-
"example": "
|
|
37773
|
+
"example": "2024-01-25 17:12:58.747156+00"
|
|
37728
37774
|
}, {
|
|
37729
37775
|
"name": "authorizations",
|
|
37730
37776
|
"type": "[payment_authorization]",
|
|
@@ -37974,6 +38020,13 @@
|
|
|
37974
38020
|
"attributes": [],
|
|
37975
38021
|
"annotations": [],
|
|
37976
38022
|
"description": "Information for recurring or vaulted card integrations to support returning customer checkouts."
|
|
38023
|
+
}, {
|
|
38024
|
+
"name": "reference",
|
|
38025
|
+
"type": "string",
|
|
38026
|
+
"required": false,
|
|
38027
|
+
"attributes": [],
|
|
38028
|
+
"annotations": [],
|
|
38029
|
+
"description": "Custom payment identifier"
|
|
37977
38030
|
}],
|
|
37978
38031
|
"attributes": [],
|
|
37979
38032
|
"interfaces": []
|
|
@@ -38062,12 +38115,12 @@
|
|
|
38062
38115
|
"name": "payment_method_data_init_afterpay",
|
|
38063
38116
|
"plural": "payment_method_data_init_afterpays",
|
|
38064
38117
|
"fields": [{
|
|
38065
|
-
"name": "
|
|
38118
|
+
"name": "reference",
|
|
38066
38119
|
"type": "string",
|
|
38067
38120
|
"required": false,
|
|
38068
38121
|
"attributes": [],
|
|
38069
38122
|
"annotations": [],
|
|
38070
|
-
"description": "
|
|
38123
|
+
"description": "Custom payment identifier"
|
|
38071
38124
|
}],
|
|
38072
38125
|
"attributes": [],
|
|
38073
38126
|
"interfaces": []
|
|
@@ -38075,12 +38128,12 @@
|
|
|
38075
38128
|
"name": "payment_method_data_init_applepay",
|
|
38076
38129
|
"plural": "payment_method_data_init_applepays",
|
|
38077
38130
|
"fields": [{
|
|
38078
|
-
"name": "
|
|
38131
|
+
"name": "reference",
|
|
38079
38132
|
"type": "string",
|
|
38080
38133
|
"required": false,
|
|
38081
38134
|
"attributes": [],
|
|
38082
38135
|
"annotations": [],
|
|
38083
|
-
"description": "
|
|
38136
|
+
"description": "Custom payment identifier"
|
|
38084
38137
|
}],
|
|
38085
38138
|
"attributes": [],
|
|
38086
38139
|
"interfaces": []
|
|
@@ -38088,12 +38141,12 @@
|
|
|
38088
38141
|
"name": "payment_method_data_init_bancontact",
|
|
38089
38142
|
"plural": "payment_method_data_init_bancontacts",
|
|
38090
38143
|
"fields": [{
|
|
38091
|
-
"name": "
|
|
38144
|
+
"name": "reference",
|
|
38092
38145
|
"type": "string",
|
|
38093
38146
|
"required": false,
|
|
38094
38147
|
"attributes": [],
|
|
38095
38148
|
"annotations": [],
|
|
38096
|
-
"description": "
|
|
38149
|
+
"description": "Custom payment identifier"
|
|
38097
38150
|
}],
|
|
38098
38151
|
"attributes": [],
|
|
38099
38152
|
"interfaces": []
|
|
@@ -38101,12 +38154,12 @@
|
|
|
38101
38154
|
"name": "payment_method_data_init_googlepay",
|
|
38102
38155
|
"plural": "payment_method_data_init_googlepays",
|
|
38103
38156
|
"fields": [{
|
|
38104
|
-
"name": "
|
|
38157
|
+
"name": "reference",
|
|
38105
38158
|
"type": "string",
|
|
38106
38159
|
"required": false,
|
|
38107
38160
|
"attributes": [],
|
|
38108
38161
|
"annotations": [],
|
|
38109
|
-
"description": "
|
|
38162
|
+
"description": "Custom payment identifier"
|
|
38110
38163
|
}],
|
|
38111
38164
|
"attributes": [],
|
|
38112
38165
|
"interfaces": []
|
|
@@ -38119,6 +38172,13 @@
|
|
|
38119
38172
|
"required": false,
|
|
38120
38173
|
"attributes": [],
|
|
38121
38174
|
"annotations": []
|
|
38175
|
+
}, {
|
|
38176
|
+
"name": "reference",
|
|
38177
|
+
"type": "string",
|
|
38178
|
+
"required": false,
|
|
38179
|
+
"attributes": [],
|
|
38180
|
+
"annotations": [],
|
|
38181
|
+
"description": "Custom payment identifier"
|
|
38122
38182
|
}],
|
|
38123
38183
|
"attributes": [],
|
|
38124
38184
|
"interfaces": []
|
|
@@ -38126,12 +38186,12 @@
|
|
|
38126
38186
|
"name": "payment_method_data_init_klarna",
|
|
38127
38187
|
"plural": "payment_method_data_init_klarnas",
|
|
38128
38188
|
"fields": [{
|
|
38129
|
-
"name": "
|
|
38189
|
+
"name": "reference",
|
|
38130
38190
|
"type": "string",
|
|
38131
38191
|
"required": false,
|
|
38132
38192
|
"attributes": [],
|
|
38133
38193
|
"annotations": [],
|
|
38134
|
-
"description": "
|
|
38194
|
+
"description": "Custom payment identifier"
|
|
38135
38195
|
}],
|
|
38136
38196
|
"attributes": [],
|
|
38137
38197
|
"interfaces": []
|
|
@@ -38139,12 +38199,12 @@
|
|
|
38139
38199
|
"name": "payment_method_data_init_paypal",
|
|
38140
38200
|
"plural": "payment_method_data_init_paypals",
|
|
38141
38201
|
"fields": [{
|
|
38142
|
-
"name": "
|
|
38202
|
+
"name": "reference",
|
|
38143
38203
|
"type": "string",
|
|
38144
38204
|
"required": false,
|
|
38145
38205
|
"attributes": [],
|
|
38146
38206
|
"annotations": [],
|
|
38147
|
-
"description": "
|
|
38207
|
+
"description": "Custom payment identifier"
|
|
38148
38208
|
}],
|
|
38149
38209
|
"attributes": [],
|
|
38150
38210
|
"interfaces": []
|
|
@@ -38152,12 +38212,12 @@
|
|
|
38152
38212
|
"name": "payment_method_data_init_sofort",
|
|
38153
38213
|
"plural": "payment_method_data_init_soforts",
|
|
38154
38214
|
"fields": [{
|
|
38155
|
-
"name": "
|
|
38215
|
+
"name": "reference",
|
|
38156
38216
|
"type": "string",
|
|
38157
38217
|
"required": false,
|
|
38158
38218
|
"attributes": [],
|
|
38159
38219
|
"annotations": [],
|
|
38160
|
-
"description": "
|
|
38220
|
+
"description": "Custom payment identifier"
|
|
38161
38221
|
}],
|
|
38162
38222
|
"attributes": [],
|
|
38163
38223
|
"interfaces": []
|
|
@@ -38566,7 +38626,7 @@
|
|
|
38566
38626
|
"fields": [{
|
|
38567
38627
|
"name": "id",
|
|
38568
38628
|
"type": "string",
|
|
38569
|
-
"required":
|
|
38629
|
+
"required": false,
|
|
38570
38630
|
"attributes": [],
|
|
38571
38631
|
"annotations": [],
|
|
38572
38632
|
"description": "Item identifier, i.e. SKU or GTIN"
|
|
@@ -38986,6 +39046,13 @@
|
|
|
38986
39046
|
"annotations": [],
|
|
38987
39047
|
"description": "The ISO 4217-3 code for the base currency.",
|
|
38988
39048
|
"example": "CAD"
|
|
39049
|
+
}, {
|
|
39050
|
+
"name": "reference",
|
|
39051
|
+
"type": "string",
|
|
39052
|
+
"required": false,
|
|
39053
|
+
"attributes": [],
|
|
39054
|
+
"annotations": [],
|
|
39055
|
+
"description": "Custom payment identifier"
|
|
38989
39056
|
}, {
|
|
38990
39057
|
"name": "created_at",
|
|
38991
39058
|
"type": "date-time-iso8601",
|
|
@@ -39028,6 +39095,13 @@
|
|
|
39028
39095
|
"annotations": [],
|
|
39029
39096
|
"description": "The ISO 4217-3 code for the currency. Required if amount is specified. Case insensitive. Must match the transaction currency or the base currency. See https://api.flow.io/reference/currencies",
|
|
39030
39097
|
"example": "CAD"
|
|
39098
|
+
}, {
|
|
39099
|
+
"name": "reference",
|
|
39100
|
+
"type": "string",
|
|
39101
|
+
"required": false,
|
|
39102
|
+
"attributes": [],
|
|
39103
|
+
"annotations": [],
|
|
39104
|
+
"description": "Custom payment identifier"
|
|
39031
39105
|
}],
|
|
39032
39106
|
"attributes": [],
|
|
39033
39107
|
"interfaces": [],
|
|
@@ -39556,6 +39630,13 @@
|
|
|
39556
39630
|
"annotations": [],
|
|
39557
39631
|
"description": "The ISO 4217-3 code for the base currency.",
|
|
39558
39632
|
"example": "CAD"
|
|
39633
|
+
}, {
|
|
39634
|
+
"name": "reference",
|
|
39635
|
+
"type": "string",
|
|
39636
|
+
"required": false,
|
|
39637
|
+
"attributes": [],
|
|
39638
|
+
"annotations": [],
|
|
39639
|
+
"description": "Custom payment identifier"
|
|
39559
39640
|
}, {
|
|
39560
39641
|
"name": "created_at",
|
|
39561
39642
|
"type": "date-time-iso8601",
|
|
@@ -39597,6 +39678,13 @@
|
|
|
39597
39678
|
"annotations": [],
|
|
39598
39679
|
"description": "Required if amount is specified. The ISO 4217-3 code for the currency. Case insensitive. See https://api.flow.io/reference/currencies",
|
|
39599
39680
|
"example": "CAD"
|
|
39681
|
+
}, {
|
|
39682
|
+
"name": "reference",
|
|
39683
|
+
"type": "string",
|
|
39684
|
+
"required": false,
|
|
39685
|
+
"attributes": [],
|
|
39686
|
+
"annotations": [],
|
|
39687
|
+
"description": "Custom payment identifier"
|
|
39600
39688
|
}],
|
|
39601
39689
|
"attributes": [],
|
|
39602
39690
|
"interfaces": [],
|
|
@@ -41630,11 +41718,12 @@
|
|
|
41630
41718
|
"annotations": [],
|
|
41631
41719
|
"description": "Refers to your organization's account identifier"
|
|
41632
41720
|
}, {
|
|
41633
|
-
"name": "
|
|
41634
|
-
"type": "
|
|
41721
|
+
"name": "id",
|
|
41722
|
+
"type": "string",
|
|
41635
41723
|
"required": true,
|
|
41636
41724
|
"attributes": [],
|
|
41637
|
-
"annotations": []
|
|
41725
|
+
"annotations": [],
|
|
41726
|
+
"description": "Globally unique identifier"
|
|
41638
41727
|
}],
|
|
41639
41728
|
"attributes": [],
|
|
41640
41729
|
"interfaces": []
|
|
@@ -53338,7 +53427,7 @@
|
|
|
53338
53427
|
"description": "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none. Values are expressed as '0.0295' to represent '2.95%'"
|
|
53339
53428
|
}, {
|
|
53340
53429
|
"name": "outbound",
|
|
53341
|
-
"type": "
|
|
53430
|
+
"type": "transaction_metadata_outbound_transaction",
|
|
53342
53431
|
"required": false,
|
|
53343
53432
|
"attributes": [],
|
|
53344
53433
|
"annotations": []
|
|
@@ -53346,11 +53435,35 @@
|
|
|
53346
53435
|
"attributes": [],
|
|
53347
53436
|
"interfaces": []
|
|
53348
53437
|
}, {
|
|
53349
|
-
"name": "
|
|
53350
|
-
"plural": "
|
|
53438
|
+
"name": "transaction_metadata_carrier_fee",
|
|
53439
|
+
"plural": "transaction_metadata_carrier_fees",
|
|
53351
53440
|
"fields": [{
|
|
53352
|
-
"name": "
|
|
53353
|
-
"type": "
|
|
53441
|
+
"name": "outbound",
|
|
53442
|
+
"type": "transaction_metadata_outbound_transaction",
|
|
53443
|
+
"required": true,
|
|
53444
|
+
"attributes": [],
|
|
53445
|
+
"annotations": []
|
|
53446
|
+
}, {
|
|
53447
|
+
"name": "estimate",
|
|
53448
|
+
"type": "transaction_metadata_carrier_fee_data",
|
|
53449
|
+
"required": true,
|
|
53450
|
+
"attributes": [],
|
|
53451
|
+
"annotations": []
|
|
53452
|
+
}, {
|
|
53453
|
+
"name": "actual",
|
|
53454
|
+
"type": "transaction_metadata_carrier_fee_data",
|
|
53455
|
+
"required": true,
|
|
53456
|
+
"attributes": [],
|
|
53457
|
+
"annotations": []
|
|
53458
|
+
}],
|
|
53459
|
+
"attributes": [],
|
|
53460
|
+
"interfaces": []
|
|
53461
|
+
}, {
|
|
53462
|
+
"name": "transaction_metadata_carrier_fee_data",
|
|
53463
|
+
"plural": "transaction_metadata_carrier_fee_data",
|
|
53464
|
+
"fields": [{
|
|
53465
|
+
"name": "surcharges",
|
|
53466
|
+
"type": "[trueup_label_surcharge]",
|
|
53354
53467
|
"required": true,
|
|
53355
53468
|
"attributes": [],
|
|
53356
53469
|
"annotations": []
|
|
@@ -53449,6 +53562,30 @@
|
|
|
53449
53562
|
}],
|
|
53450
53563
|
"attributes": [],
|
|
53451
53564
|
"interfaces": []
|
|
53565
|
+
}, {
|
|
53566
|
+
"name": "transaction_metadata_outbound_transaction",
|
|
53567
|
+
"plural": "transaction_metadata_outbound_transactions",
|
|
53568
|
+
"fields": [{
|
|
53569
|
+
"name": "transaction_id",
|
|
53570
|
+
"type": "string",
|
|
53571
|
+
"required": true,
|
|
53572
|
+
"attributes": [],
|
|
53573
|
+
"annotations": []
|
|
53574
|
+
}],
|
|
53575
|
+
"attributes": [],
|
|
53576
|
+
"interfaces": []
|
|
53577
|
+
}, {
|
|
53578
|
+
"name": "transaction_metadata_payment_transaction",
|
|
53579
|
+
"plural": "transaction_metadata_payment_transactions",
|
|
53580
|
+
"fields": [{
|
|
53581
|
+
"name": "key",
|
|
53582
|
+
"type": "string",
|
|
53583
|
+
"required": false,
|
|
53584
|
+
"attributes": [],
|
|
53585
|
+
"annotations": []
|
|
53586
|
+
}],
|
|
53587
|
+
"attributes": [],
|
|
53588
|
+
"interfaces": []
|
|
53452
53589
|
}, {
|
|
53453
53590
|
"name": "transaction_metadata_shipping_label",
|
|
53454
53591
|
"plural": "transaction_metadata_shipping_labels",
|
|
@@ -54074,7 +54211,10 @@
|
|
|
54074
54211
|
}],
|
|
54075
54212
|
"attributes": [],
|
|
54076
54213
|
"interfaces": [],
|
|
54077
|
-
"description": "Virtual credit cards are created for a specific limit and currency. Currently only USD denominated cards can be issued. Once created the virtual card can be used in the same way as a physical credit card using the card number, cvv and expiration details."
|
|
54214
|
+
"description": "Virtual credit cards are created for a specific limit and currency. Currently only USD denominated cards can be issued. Once created the virtual card can be used in the same way as a physical credit card using the card number, cvv and expiration details.",
|
|
54215
|
+
"deprecation": {
|
|
54216
|
+
"description": "Virtual cards are not supported anymore"
|
|
54217
|
+
}
|
|
54078
54218
|
}, {
|
|
54079
54219
|
"name": "virtual_card_capture",
|
|
54080
54220
|
"plural": "virtual_card_captures",
|
|
@@ -54132,7 +54272,10 @@
|
|
|
54132
54272
|
}],
|
|
54133
54273
|
"attributes": [],
|
|
54134
54274
|
"interfaces": [],
|
|
54135
|
-
"description": "Payment has been captured for the virtual credit card"
|
|
54275
|
+
"description": "Payment has been captured for the virtual credit card",
|
|
54276
|
+
"deprecation": {
|
|
54277
|
+
"description": "Virtual cards are not supported anymore"
|
|
54278
|
+
}
|
|
54136
54279
|
}, {
|
|
54137
54280
|
"name": "virtual_card_capture_deleted",
|
|
54138
54281
|
"plural": "virtual_card_capture_deleteds",
|
|
@@ -54165,7 +54308,10 @@
|
|
|
54165
54308
|
}],
|
|
54166
54309
|
"attributes": [],
|
|
54167
54310
|
"interfaces": [],
|
|
54168
|
-
"description": "Event emitted when a previous virtual card capture has been deleted."
|
|
54311
|
+
"description": "Event emitted when a previous virtual card capture has been deleted.",
|
|
54312
|
+
"deprecation": {
|
|
54313
|
+
"description": "Virtual cards are not supported anymore"
|
|
54314
|
+
}
|
|
54169
54315
|
}, {
|
|
54170
54316
|
"name": "virtual_card_capture_upserted",
|
|
54171
54317
|
"plural": "virtual_card_capture_upserteds",
|
|
@@ -54204,7 +54350,10 @@
|
|
|
54204
54350
|
}],
|
|
54205
54351
|
"attributes": [],
|
|
54206
54352
|
"interfaces": [],
|
|
54207
|
-
"description": "Emitted when a capture event occurs against an existing virtual credit card."
|
|
54353
|
+
"description": "Emitted when a capture event occurs against an existing virtual credit card.",
|
|
54354
|
+
"deprecation": {
|
|
54355
|
+
"description": "Virtual cards are not supported anymore"
|
|
54356
|
+
}
|
|
54208
54357
|
}, {
|
|
54209
54358
|
"name": "virtual_card_capture_version",
|
|
54210
54359
|
"plural": "virtual_card_capture_versions",
|
|
@@ -54235,27 +54384,10 @@
|
|
|
54235
54384
|
"annotations": []
|
|
54236
54385
|
}],
|
|
54237
54386
|
"attributes": [],
|
|
54238
|
-
"interfaces": []
|
|
54239
|
-
|
|
54240
|
-
|
|
54241
|
-
|
|
54242
|
-
"fields": [{
|
|
54243
|
-
"name": "limit",
|
|
54244
|
-
"type": "money",
|
|
54245
|
-
"required": true,
|
|
54246
|
-
"attributes": [],
|
|
54247
|
-
"annotations": [],
|
|
54248
|
-
"description": "The requested limit of the card"
|
|
54249
|
-
}, {
|
|
54250
|
-
"name": "attributes",
|
|
54251
|
-
"type": "map[string]",
|
|
54252
|
-
"required": false,
|
|
54253
|
-
"attributes": [],
|
|
54254
|
-
"annotations": [],
|
|
54255
|
-
"description": "A set of key/value pairs that you can attach to a virtual card object"
|
|
54256
|
-
}],
|
|
54257
|
-
"attributes": [],
|
|
54258
|
-
"interfaces": []
|
|
54387
|
+
"interfaces": [],
|
|
54388
|
+
"deprecation": {
|
|
54389
|
+
"description": "Virtual cards are not supported anymore"
|
|
54390
|
+
}
|
|
54259
54391
|
}, {
|
|
54260
54392
|
"name": "virtual_card_reference",
|
|
54261
54393
|
"plural": "virtual_card_references",
|
|
@@ -54269,7 +54401,10 @@
|
|
|
54269
54401
|
}],
|
|
54270
54402
|
"attributes": [],
|
|
54271
54403
|
"interfaces": [],
|
|
54272
|
-
"description": "Flows reference identifier for the virtual credit card."
|
|
54404
|
+
"description": "Flows reference identifier for the virtual credit card.",
|
|
54405
|
+
"deprecation": {
|
|
54406
|
+
"description": "Virtual cards are not supported anymore"
|
|
54407
|
+
}
|
|
54273
54408
|
}, {
|
|
54274
54409
|
"name": "virtual_card_refund",
|
|
54275
54410
|
"plural": "virtual_card_refunds",
|
|
@@ -54327,7 +54462,10 @@
|
|
|
54327
54462
|
}],
|
|
54328
54463
|
"attributes": [],
|
|
54329
54464
|
"interfaces": [],
|
|
54330
|
-
"description": "A refund has been issued for the virtual credit card"
|
|
54465
|
+
"description": "A refund has been issued for the virtual credit card",
|
|
54466
|
+
"deprecation": {
|
|
54467
|
+
"description": "Virtual cards are not supported anymore"
|
|
54468
|
+
}
|
|
54331
54469
|
}, {
|
|
54332
54470
|
"name": "virtual_card_refund_deleted",
|
|
54333
54471
|
"plural": "virtual_card_refund_deleteds",
|
|
@@ -54360,7 +54498,10 @@
|
|
|
54360
54498
|
}],
|
|
54361
54499
|
"attributes": [],
|
|
54362
54500
|
"interfaces": [],
|
|
54363
|
-
"description": "Event emitted when a previous virtual card refund has been deleted."
|
|
54501
|
+
"description": "Event emitted when a previous virtual card refund has been deleted.",
|
|
54502
|
+
"deprecation": {
|
|
54503
|
+
"description": "Virtual cards are not supported anymore"
|
|
54504
|
+
}
|
|
54364
54505
|
}, {
|
|
54365
54506
|
"name": "virtual_card_refund_upserted",
|
|
54366
54507
|
"plural": "virtual_card_refund_upserteds",
|
|
@@ -54399,7 +54540,10 @@
|
|
|
54399
54540
|
}],
|
|
54400
54541
|
"attributes": [],
|
|
54401
54542
|
"interfaces": [],
|
|
54402
|
-
"description": "Emitted when a refund event occurs against an existing virtual credit card."
|
|
54543
|
+
"description": "Emitted when a refund event occurs against an existing virtual credit card.",
|
|
54544
|
+
"deprecation": {
|
|
54545
|
+
"description": "Virtual cards are not supported anymore"
|
|
54546
|
+
}
|
|
54403
54547
|
}, {
|
|
54404
54548
|
"name": "virtual_card_refund_version",
|
|
54405
54549
|
"plural": "virtual_card_refund_versions",
|
|
@@ -54430,7 +54574,10 @@
|
|
|
54430
54574
|
"annotations": []
|
|
54431
54575
|
}],
|
|
54432
54576
|
"attributes": [],
|
|
54433
|
-
"interfaces": []
|
|
54577
|
+
"interfaces": [],
|
|
54578
|
+
"deprecation": {
|
|
54579
|
+
"description": "Virtual cards are not supported anymore"
|
|
54580
|
+
}
|
|
54434
54581
|
}, {
|
|
54435
54582
|
"name": "virtual_card_version",
|
|
54436
54583
|
"plural": "virtual_card_versions",
|
|
@@ -54461,7 +54608,10 @@
|
|
|
54461
54608
|
"annotations": []
|
|
54462
54609
|
}],
|
|
54463
54610
|
"attributes": [],
|
|
54464
|
-
"interfaces": []
|
|
54611
|
+
"interfaces": [],
|
|
54612
|
+
"deprecation": {
|
|
54613
|
+
"description": "Virtual cards are not supported anymore"
|
|
54614
|
+
}
|
|
54465
54615
|
}, {
|
|
54466
54616
|
"name": "webhook",
|
|
54467
54617
|
"plural": "webhooks",
|
|
@@ -60042,6 +60192,42 @@
|
|
|
60042
60192
|
"required": false,
|
|
60043
60193
|
"description": "Find items with this number. Case insensitive. Exact match",
|
|
60044
60194
|
"maximum": 100
|
|
60195
|
+
}, {
|
|
60196
|
+
"name": "sku",
|
|
60197
|
+
"type": "[string]",
|
|
60198
|
+
"location": "Query",
|
|
60199
|
+
"required": false,
|
|
60200
|
+
"maximum": 100
|
|
60201
|
+
}, {
|
|
60202
|
+
"name": "product_title",
|
|
60203
|
+
"type": "[string]",
|
|
60204
|
+
"location": "Query",
|
|
60205
|
+
"required": false,
|
|
60206
|
+
"maximum": 100
|
|
60207
|
+
}, {
|
|
60208
|
+
"name": "product_id",
|
|
60209
|
+
"type": "[string]",
|
|
60210
|
+
"location": "Query",
|
|
60211
|
+
"required": false,
|
|
60212
|
+
"maximum": 100
|
|
60213
|
+
}, {
|
|
60214
|
+
"name": "vendor",
|
|
60215
|
+
"type": "[string]",
|
|
60216
|
+
"location": "Query",
|
|
60217
|
+
"required": false,
|
|
60218
|
+
"maximum": 100
|
|
60219
|
+
}, {
|
|
60220
|
+
"name": "barcode",
|
|
60221
|
+
"type": "[string]",
|
|
60222
|
+
"location": "Query",
|
|
60223
|
+
"required": false,
|
|
60224
|
+
"maximum": 100
|
|
60225
|
+
}, {
|
|
60226
|
+
"name": "physical_good",
|
|
60227
|
+
"type": "boolean",
|
|
60228
|
+
"location": "Query",
|
|
60229
|
+
"required": false,
|
|
60230
|
+
"maximum": 100
|
|
60045
60231
|
}, {
|
|
60046
60232
|
"name": "limit",
|
|
60047
60233
|
"type": "long",
|
|
@@ -65103,7 +65289,7 @@
|
|
|
65103
65289
|
"type": "string",
|
|
65104
65290
|
"location": "Query",
|
|
65105
65291
|
"required": true,
|
|
65106
|
-
"default": "
|
|
65292
|
+
"default": "id"
|
|
65107
65293
|
}],
|
|
65108
65294
|
"responses": [{
|
|
65109
65295
|
"code": {
|
|
@@ -65140,6 +65326,11 @@
|
|
|
65140
65326
|
"value": "created_at"
|
|
65141
65327
|
}]
|
|
65142
65328
|
}
|
|
65329
|
+
}, {
|
|
65330
|
+
"name": "linter",
|
|
65331
|
+
"value": {
|
|
65332
|
+
"ignore": ["sort_parameter_default"]
|
|
65333
|
+
}
|
|
65143
65334
|
}],
|
|
65144
65335
|
"description": "Search organizations. Always paginated."
|
|
65145
65336
|
}, {
|
|
@@ -70993,208 +71184,10 @@
|
|
|
70993
71184
|
"description": "Resource was not found",
|
|
70994
71185
|
"attributes": []
|
|
70995
71186
|
}],
|
|
70996
|
-
"attributes": []
|
|
70997
|
-
}, {
|
|
70998
|
-
"method": "PUT",
|
|
70999
|
-
"path": "/:organization/reversals/:key",
|
|
71000
|
-
"parameters": [{
|
|
71001
|
-
"name": "organization",
|
|
71002
|
-
"type": "string",
|
|
71003
|
-
"location": "Path",
|
|
71004
|
-
"required": true,
|
|
71005
|
-
"description": "Refers to your organization's account identifier"
|
|
71006
|
-
}, {
|
|
71007
|
-
"name": "key",
|
|
71008
|
-
"type": "string",
|
|
71009
|
-
"location": "Path",
|
|
71010
|
-
"required": true
|
|
71011
|
-
}],
|
|
71012
|
-
"responses": [{
|
|
71013
|
-
"code": {
|
|
71014
|
-
"integer": {
|
|
71015
|
-
"value": 201
|
|
71016
|
-
}
|
|
71017
|
-
},
|
|
71018
|
-
"type": "reversal",
|
|
71019
|
-
"description": "Operation succeeded and the resource was created",
|
|
71020
|
-
"attributes": []
|
|
71021
|
-
}, {
|
|
71022
|
-
"code": {
|
|
71023
|
-
"integer": {
|
|
71024
|
-
"value": 401
|
|
71025
|
-
}
|
|
71026
|
-
},
|
|
71027
|
-
"type": "unit",
|
|
71028
|
-
"description": "Authorization failed",
|
|
71029
|
-
"attributes": []
|
|
71030
|
-
}, {
|
|
71031
|
-
"code": {
|
|
71032
|
-
"integer": {
|
|
71033
|
-
"value": 404
|
|
71034
|
-
}
|
|
71035
|
-
},
|
|
71036
|
-
"type": "unit",
|
|
71037
|
-
"description": "No such authorization",
|
|
71038
|
-
"attributes": []
|
|
71039
|
-
}, {
|
|
71040
|
-
"code": {
|
|
71041
|
-
"integer": {
|
|
71042
|
-
"value": 422
|
|
71043
|
-
}
|
|
71044
|
-
},
|
|
71045
|
-
"type": "reversal_error",
|
|
71046
|
-
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
71047
|
-
"attributes": []
|
|
71048
|
-
}],
|
|
71049
|
-
"attributes": [],
|
|
71050
|
-
"description": "Try inserting or updating a new reversal. Useful for retrying pending reversals",
|
|
71051
|
-
"body": {
|
|
71052
|
-
"type": "reversal_put_form",
|
|
71053
|
-
"attributes": []
|
|
71054
|
-
}
|
|
71055
|
-
}],
|
|
71056
|
-
"attributes": [{
|
|
71057
|
-
"name": "docs",
|
|
71058
|
-
"value": {
|
|
71059
|
-
"module": "payment"
|
|
71060
|
-
}
|
|
71061
|
-
}],
|
|
71062
|
-
"path": "/:organization/reversals",
|
|
71063
|
-
"description": "A reversal is used to clear an authorization (full or partial)."
|
|
71064
|
-
}, {
|
|
71065
|
-
"type": "virtual_card",
|
|
71066
|
-
"plural": "virtual_cards",
|
|
71067
|
-
"operations": [{
|
|
71068
|
-
"method": "GET",
|
|
71069
|
-
"path": "/:organization/virtual/cards",
|
|
71070
|
-
"parameters": [{
|
|
71071
|
-
"name": "organization",
|
|
71072
|
-
"type": "string",
|
|
71073
|
-
"location": "Path",
|
|
71074
|
-
"required": true,
|
|
71075
|
-
"description": "Refers to your organization's account identifier"
|
|
71076
|
-
}, {
|
|
71077
|
-
"name": "id",
|
|
71078
|
-
"type": "[string]",
|
|
71079
|
-
"location": "Query",
|
|
71080
|
-
"required": false,
|
|
71081
|
-
"description": "Filter by one or more IDs of this resource",
|
|
71082
|
-
"maximum": 100
|
|
71083
|
-
}, {
|
|
71084
|
-
"name": "key",
|
|
71085
|
-
"type": "string",
|
|
71086
|
-
"location": "Query",
|
|
71087
|
-
"required": false
|
|
71088
|
-
}, {
|
|
71089
|
-
"name": "limit",
|
|
71090
|
-
"type": "long",
|
|
71091
|
-
"location": "Query",
|
|
71092
|
-
"required": true,
|
|
71093
|
-
"description": "The maximum number of results to return",
|
|
71094
|
-
"default": "25",
|
|
71095
|
-
"minimum": 1,
|
|
71096
|
-
"maximum": 100
|
|
71097
|
-
}, {
|
|
71098
|
-
"name": "offset",
|
|
71099
|
-
"type": "long",
|
|
71100
|
-
"location": "Query",
|
|
71101
|
-
"required": true,
|
|
71102
|
-
"description": "The number of results to skip before returning results",
|
|
71103
|
-
"default": "0",
|
|
71104
|
-
"minimum": 0
|
|
71105
|
-
}, {
|
|
71106
|
-
"name": "sort",
|
|
71107
|
-
"type": "string",
|
|
71108
|
-
"location": "Query",
|
|
71109
|
-
"required": true,
|
|
71110
|
-
"default": "-created_at"
|
|
71111
|
-
}],
|
|
71112
|
-
"responses": [{
|
|
71113
|
-
"code": {
|
|
71114
|
-
"integer": {
|
|
71115
|
-
"value": 200
|
|
71116
|
-
}
|
|
71117
|
-
},
|
|
71118
|
-
"type": "[virtual_card]",
|
|
71119
|
-
"description": "Successful response",
|
|
71120
|
-
"attributes": []
|
|
71121
|
-
}, {
|
|
71122
|
-
"code": {
|
|
71123
|
-
"integer": {
|
|
71124
|
-
"value": 401
|
|
71125
|
-
}
|
|
71126
|
-
},
|
|
71127
|
-
"type": "unit",
|
|
71128
|
-
"description": "Authorization failed",
|
|
71129
|
-
"attributes": []
|
|
71130
|
-
}],
|
|
71131
|
-
"attributes": [{
|
|
71132
|
-
"name": "sort",
|
|
71133
|
-
"value": {
|
|
71134
|
-
"values": [{
|
|
71135
|
-
"value": "id"
|
|
71136
|
-
}, {
|
|
71137
|
-
"value": "key"
|
|
71138
|
-
}, {
|
|
71139
|
-
"value": "created_at"
|
|
71140
|
-
}]
|
|
71141
|
-
}
|
|
71142
|
-
}, {
|
|
71143
|
-
"name": "linter",
|
|
71144
|
-
"value": {
|
|
71145
|
-
"ignore": ["sort_parameter_default", "versions"]
|
|
71146
|
-
}
|
|
71147
|
-
}],
|
|
71148
|
-
"description": "Retrieve all the virtual credit cards that have been created matching selected criteria."
|
|
71149
|
-
}, {
|
|
71150
|
-
"method": "GET",
|
|
71151
|
-
"path": "/:organization/virtual/cards/:key",
|
|
71152
|
-
"parameters": [{
|
|
71153
|
-
"name": "organization",
|
|
71154
|
-
"type": "string",
|
|
71155
|
-
"location": "Path",
|
|
71156
|
-
"required": true,
|
|
71157
|
-
"description": "Refers to your organization's account identifier"
|
|
71158
|
-
}, {
|
|
71159
|
-
"name": "key",
|
|
71160
|
-
"type": "string",
|
|
71161
|
-
"location": "Path",
|
|
71162
|
-
"required": true,
|
|
71163
|
-
"description": "Your unique identifier for this virtual card."
|
|
71164
|
-
}],
|
|
71165
|
-
"responses": [{
|
|
71166
|
-
"code": {
|
|
71167
|
-
"integer": {
|
|
71168
|
-
"value": 200
|
|
71169
|
-
}
|
|
71170
|
-
},
|
|
71171
|
-
"type": "virtual_card",
|
|
71172
|
-
"description": "Successful response",
|
|
71173
|
-
"attributes": []
|
|
71174
|
-
}, {
|
|
71175
|
-
"code": {
|
|
71176
|
-
"integer": {
|
|
71177
|
-
"value": 401
|
|
71178
|
-
}
|
|
71179
|
-
},
|
|
71180
|
-
"type": "unit",
|
|
71181
|
-
"description": "Authorization failed",
|
|
71182
|
-
"attributes": []
|
|
71183
|
-
}, {
|
|
71184
|
-
"code": {
|
|
71185
|
-
"integer": {
|
|
71186
|
-
"value": 404
|
|
71187
|
-
}
|
|
71188
|
-
},
|
|
71189
|
-
"type": "unit",
|
|
71190
|
-
"description": "Resource was not found",
|
|
71191
|
-
"attributes": []
|
|
71192
|
-
}],
|
|
71193
|
-
"attributes": [],
|
|
71194
|
-
"description": "Retrieves a virtual credit card using your unique key used when creating the card. Note that the card number and cvv will not be returned by this request to maintain PCI compliance. If you have lost these details you will need to create a new card."
|
|
71187
|
+
"attributes": []
|
|
71195
71188
|
}, {
|
|
71196
71189
|
"method": "PUT",
|
|
71197
|
-
"path": "/:organization/
|
|
71190
|
+
"path": "/:organization/reversals/:key",
|
|
71198
71191
|
"parameters": [{
|
|
71199
71192
|
"name": "organization",
|
|
71200
71193
|
"type": "string",
|
|
@@ -71205,14 +71198,7 @@
|
|
|
71205
71198
|
"name": "key",
|
|
71206
71199
|
"type": "string",
|
|
71207
71200
|
"location": "Path",
|
|
71208
|
-
"required": true
|
|
71209
|
-
"description": "Your unique identifier for this virtual card, which is used to implement idempotency."
|
|
71210
|
-
}, {
|
|
71211
|
-
"name": "authorization_key",
|
|
71212
|
-
"type": "string",
|
|
71213
|
-
"location": "Path",
|
|
71214
|
-
"required": true,
|
|
71215
|
-
"description": "The key of the authorization against which to issue the virtual card."
|
|
71201
|
+
"required": true
|
|
71216
71202
|
}],
|
|
71217
71203
|
"responses": [{
|
|
71218
71204
|
"code": {
|
|
@@ -71220,7 +71206,7 @@
|
|
|
71220
71206
|
"value": 201
|
|
71221
71207
|
}
|
|
71222
71208
|
},
|
|
71223
|
-
"type": "
|
|
71209
|
+
"type": "reversal",
|
|
71224
71210
|
"description": "Operation succeeded and the resource was created",
|
|
71225
71211
|
"attributes": []
|
|
71226
71212
|
}, {
|
|
@@ -71239,7 +71225,7 @@
|
|
|
71239
71225
|
}
|
|
71240
71226
|
},
|
|
71241
71227
|
"type": "unit",
|
|
71242
|
-
"description": "
|
|
71228
|
+
"description": "No such authorization",
|
|
71243
71229
|
"attributes": []
|
|
71244
71230
|
}, {
|
|
71245
71231
|
"code": {
|
|
@@ -71247,14 +71233,14 @@
|
|
|
71247
71233
|
"value": 422
|
|
71248
71234
|
}
|
|
71249
71235
|
},
|
|
71250
|
-
"type": "
|
|
71236
|
+
"type": "reversal_error",
|
|
71251
71237
|
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
71252
71238
|
"attributes": []
|
|
71253
71239
|
}],
|
|
71254
71240
|
"attributes": [],
|
|
71255
|
-
"description": "
|
|
71241
|
+
"description": "Try inserting or updating a new reversal. Useful for retrying pending reversals",
|
|
71256
71242
|
"body": {
|
|
71257
|
-
"type": "
|
|
71243
|
+
"type": "reversal_put_form",
|
|
71258
71244
|
"attributes": []
|
|
71259
71245
|
}
|
|
71260
71246
|
}],
|
|
@@ -71264,284 +71250,8 @@
|
|
|
71264
71250
|
"module": "payment"
|
|
71265
71251
|
}
|
|
71266
71252
|
}],
|
|
71267
|
-
"path": "/:organization/
|
|
71268
|
-
"description": "
|
|
71269
|
-
}, {
|
|
71270
|
-
"type": "virtual_card_capture",
|
|
71271
|
-
"plural": "virtual_card_captures",
|
|
71272
|
-
"operations": [{
|
|
71273
|
-
"method": "GET",
|
|
71274
|
-
"path": "/:organization/virtual/card/captures",
|
|
71275
|
-
"parameters": [{
|
|
71276
|
-
"name": "organization",
|
|
71277
|
-
"type": "string",
|
|
71278
|
-
"location": "Path",
|
|
71279
|
-
"required": true,
|
|
71280
|
-
"description": "Refers to your organization's account identifier"
|
|
71281
|
-
}, {
|
|
71282
|
-
"name": "id",
|
|
71283
|
-
"type": "[string]",
|
|
71284
|
-
"location": "Query",
|
|
71285
|
-
"required": false,
|
|
71286
|
-
"description": "Filter by one or more IDs of this resource",
|
|
71287
|
-
"maximum": 100
|
|
71288
|
-
}, {
|
|
71289
|
-
"name": "limit",
|
|
71290
|
-
"type": "long",
|
|
71291
|
-
"location": "Query",
|
|
71292
|
-
"required": true,
|
|
71293
|
-
"description": "The maximum number of results to return",
|
|
71294
|
-
"default": "25",
|
|
71295
|
-
"minimum": 1,
|
|
71296
|
-
"maximum": 100
|
|
71297
|
-
}, {
|
|
71298
|
-
"name": "offset",
|
|
71299
|
-
"type": "long",
|
|
71300
|
-
"location": "Query",
|
|
71301
|
-
"required": true,
|
|
71302
|
-
"description": "The number of results to skip before returning results",
|
|
71303
|
-
"default": "0",
|
|
71304
|
-
"minimum": 0
|
|
71305
|
-
}, {
|
|
71306
|
-
"name": "sort",
|
|
71307
|
-
"type": "string",
|
|
71308
|
-
"location": "Query",
|
|
71309
|
-
"required": true,
|
|
71310
|
-
"default": "-created_at"
|
|
71311
|
-
}],
|
|
71312
|
-
"responses": [{
|
|
71313
|
-
"code": {
|
|
71314
|
-
"integer": {
|
|
71315
|
-
"value": 200
|
|
71316
|
-
}
|
|
71317
|
-
},
|
|
71318
|
-
"type": "[virtual_card_capture]",
|
|
71319
|
-
"description": "Successful response",
|
|
71320
|
-
"attributes": []
|
|
71321
|
-
}, {
|
|
71322
|
-
"code": {
|
|
71323
|
-
"integer": {
|
|
71324
|
-
"value": 401
|
|
71325
|
-
}
|
|
71326
|
-
},
|
|
71327
|
-
"type": "unit",
|
|
71328
|
-
"description": "Authorization failed",
|
|
71329
|
-
"attributes": []
|
|
71330
|
-
}],
|
|
71331
|
-
"attributes": [{
|
|
71332
|
-
"name": "sort",
|
|
71333
|
-
"value": {
|
|
71334
|
-
"values": [{
|
|
71335
|
-
"value": "id"
|
|
71336
|
-
}, {
|
|
71337
|
-
"value": "created_at"
|
|
71338
|
-
}]
|
|
71339
|
-
}
|
|
71340
|
-
}, {
|
|
71341
|
-
"name": "linter",
|
|
71342
|
-
"value": {
|
|
71343
|
-
"ignore": ["versions"]
|
|
71344
|
-
}
|
|
71345
|
-
}],
|
|
71346
|
-
"description": "Retrieve all the virtual credit card captures that have been received for all issued cards matching selected criteria."
|
|
71347
|
-
}, {
|
|
71348
|
-
"method": "GET",
|
|
71349
|
-
"path": "/:organization/virtual/card/captures/:virtual_card_id",
|
|
71350
|
-
"parameters": [{
|
|
71351
|
-
"name": "organization",
|
|
71352
|
-
"type": "string",
|
|
71353
|
-
"location": "Path",
|
|
71354
|
-
"required": true,
|
|
71355
|
-
"description": "Refers to your organization's account identifier"
|
|
71356
|
-
}, {
|
|
71357
|
-
"name": "virtual_card_id",
|
|
71358
|
-
"type": "string",
|
|
71359
|
-
"location": "Path",
|
|
71360
|
-
"required": true,
|
|
71361
|
-
"description": "The unique identifier for the virtual card."
|
|
71362
|
-
}],
|
|
71363
|
-
"responses": [{
|
|
71364
|
-
"code": {
|
|
71365
|
-
"integer": {
|
|
71366
|
-
"value": 200
|
|
71367
|
-
}
|
|
71368
|
-
},
|
|
71369
|
-
"type": "[virtual_card_capture]",
|
|
71370
|
-
"description": "Successful response",
|
|
71371
|
-
"attributes": []
|
|
71372
|
-
}, {
|
|
71373
|
-
"code": {
|
|
71374
|
-
"integer": {
|
|
71375
|
-
"value": 401
|
|
71376
|
-
}
|
|
71377
|
-
},
|
|
71378
|
-
"type": "unit",
|
|
71379
|
-
"description": "Authorization failed",
|
|
71380
|
-
"attributes": []
|
|
71381
|
-
}, {
|
|
71382
|
-
"code": {
|
|
71383
|
-
"integer": {
|
|
71384
|
-
"value": 404
|
|
71385
|
-
}
|
|
71386
|
-
},
|
|
71387
|
-
"type": "unit",
|
|
71388
|
-
"description": "Resource was not found",
|
|
71389
|
-
"attributes": []
|
|
71390
|
-
}],
|
|
71391
|
-
"attributes": [{
|
|
71392
|
-
"name": "linter",
|
|
71393
|
-
"value": {
|
|
71394
|
-
"ignore": ["get", "versions"]
|
|
71395
|
-
}
|
|
71396
|
-
}],
|
|
71397
|
-
"description": "Retrieve payment captures for a specific virtual credit card that has been previously issued."
|
|
71398
|
-
}],
|
|
71399
|
-
"attributes": [{
|
|
71400
|
-
"name": "docs",
|
|
71401
|
-
"value": {
|
|
71402
|
-
"module": "payment"
|
|
71403
|
-
}
|
|
71404
|
-
}],
|
|
71405
|
-
"path": "/:organization/virtual/card/captures",
|
|
71406
|
-
"description": "Payment has been captured for the virtual credit card"
|
|
71407
|
-
}, {
|
|
71408
|
-
"type": "virtual_card_refund",
|
|
71409
|
-
"plural": "virtual_card_refunds",
|
|
71410
|
-
"operations": [{
|
|
71411
|
-
"method": "GET",
|
|
71412
|
-
"path": "/:organization/virtual/card/refunds",
|
|
71413
|
-
"parameters": [{
|
|
71414
|
-
"name": "organization",
|
|
71415
|
-
"type": "string",
|
|
71416
|
-
"location": "Path",
|
|
71417
|
-
"required": true,
|
|
71418
|
-
"description": "Refers to your organization's account identifier"
|
|
71419
|
-
}, {
|
|
71420
|
-
"name": "id",
|
|
71421
|
-
"type": "[string]",
|
|
71422
|
-
"location": "Query",
|
|
71423
|
-
"required": false,
|
|
71424
|
-
"description": "Filter by one or more IDs of this resource",
|
|
71425
|
-
"maximum": 100
|
|
71426
|
-
}, {
|
|
71427
|
-
"name": "limit",
|
|
71428
|
-
"type": "long",
|
|
71429
|
-
"location": "Query",
|
|
71430
|
-
"required": true,
|
|
71431
|
-
"description": "The maximum number of results to return",
|
|
71432
|
-
"default": "25",
|
|
71433
|
-
"minimum": 1,
|
|
71434
|
-
"maximum": 100
|
|
71435
|
-
}, {
|
|
71436
|
-
"name": "offset",
|
|
71437
|
-
"type": "long",
|
|
71438
|
-
"location": "Query",
|
|
71439
|
-
"required": true,
|
|
71440
|
-
"description": "The number of results to skip before returning results",
|
|
71441
|
-
"default": "0",
|
|
71442
|
-
"minimum": 0
|
|
71443
|
-
}, {
|
|
71444
|
-
"name": "sort",
|
|
71445
|
-
"type": "string",
|
|
71446
|
-
"location": "Query",
|
|
71447
|
-
"required": true,
|
|
71448
|
-
"default": "-created_at"
|
|
71449
|
-
}],
|
|
71450
|
-
"responses": [{
|
|
71451
|
-
"code": {
|
|
71452
|
-
"integer": {
|
|
71453
|
-
"value": 200
|
|
71454
|
-
}
|
|
71455
|
-
},
|
|
71456
|
-
"type": "[virtual_card_refund]",
|
|
71457
|
-
"description": "Successful response",
|
|
71458
|
-
"attributes": []
|
|
71459
|
-
}, {
|
|
71460
|
-
"code": {
|
|
71461
|
-
"integer": {
|
|
71462
|
-
"value": 401
|
|
71463
|
-
}
|
|
71464
|
-
},
|
|
71465
|
-
"type": "unit",
|
|
71466
|
-
"description": "Authorization failed",
|
|
71467
|
-
"attributes": []
|
|
71468
|
-
}],
|
|
71469
|
-
"attributes": [{
|
|
71470
|
-
"name": "sort",
|
|
71471
|
-
"value": {
|
|
71472
|
-
"values": [{
|
|
71473
|
-
"value": "id"
|
|
71474
|
-
}, {
|
|
71475
|
-
"value": "created_at"
|
|
71476
|
-
}]
|
|
71477
|
-
}
|
|
71478
|
-
}, {
|
|
71479
|
-
"name": "linter",
|
|
71480
|
-
"value": {
|
|
71481
|
-
"ignore": ["versions"]
|
|
71482
|
-
}
|
|
71483
|
-
}],
|
|
71484
|
-
"description": "Retrieve all the virtual credit card refunds that have been received for all issued cards matching selected criteria."
|
|
71485
|
-
}, {
|
|
71486
|
-
"method": "GET",
|
|
71487
|
-
"path": "/:organization/virtual/card/refunds/:virtual_card_id",
|
|
71488
|
-
"parameters": [{
|
|
71489
|
-
"name": "organization",
|
|
71490
|
-
"type": "string",
|
|
71491
|
-
"location": "Path",
|
|
71492
|
-
"required": true,
|
|
71493
|
-
"description": "Refers to your organization's account identifier"
|
|
71494
|
-
}, {
|
|
71495
|
-
"name": "virtual_card_id",
|
|
71496
|
-
"type": "string",
|
|
71497
|
-
"location": "Path",
|
|
71498
|
-
"required": true,
|
|
71499
|
-
"description": "The unique identifier for the virtual card."
|
|
71500
|
-
}],
|
|
71501
|
-
"responses": [{
|
|
71502
|
-
"code": {
|
|
71503
|
-
"integer": {
|
|
71504
|
-
"value": 200
|
|
71505
|
-
}
|
|
71506
|
-
},
|
|
71507
|
-
"type": "[virtual_card_refund]",
|
|
71508
|
-
"description": "Successful response",
|
|
71509
|
-
"attributes": []
|
|
71510
|
-
}, {
|
|
71511
|
-
"code": {
|
|
71512
|
-
"integer": {
|
|
71513
|
-
"value": 401
|
|
71514
|
-
}
|
|
71515
|
-
},
|
|
71516
|
-
"type": "unit",
|
|
71517
|
-
"description": "Authorization failed",
|
|
71518
|
-
"attributes": []
|
|
71519
|
-
}, {
|
|
71520
|
-
"code": {
|
|
71521
|
-
"integer": {
|
|
71522
|
-
"value": 404
|
|
71523
|
-
}
|
|
71524
|
-
},
|
|
71525
|
-
"type": "unit",
|
|
71526
|
-
"description": "Resource was not found",
|
|
71527
|
-
"attributes": []
|
|
71528
|
-
}],
|
|
71529
|
-
"attributes": [{
|
|
71530
|
-
"name": "linter",
|
|
71531
|
-
"value": {
|
|
71532
|
-
"ignore": ["get", "versions"]
|
|
71533
|
-
}
|
|
71534
|
-
}],
|
|
71535
|
-
"description": "Retrieve payment refunds for a specific virtual credit card that has been previously issued."
|
|
71536
|
-
}],
|
|
71537
|
-
"attributes": [{
|
|
71538
|
-
"name": "docs",
|
|
71539
|
-
"value": {
|
|
71540
|
-
"module": "payment"
|
|
71541
|
-
}
|
|
71542
|
-
}],
|
|
71543
|
-
"path": "/:organization/virtual/card/refunds",
|
|
71544
|
-
"description": "A refund has been issued for the virtual credit card"
|
|
71253
|
+
"path": "/:organization/reversals",
|
|
71254
|
+
"description": "A reversal is used to clear an authorization (full or partial)."
|
|
71545
71255
|
}, {
|
|
71546
71256
|
"type": "center",
|
|
71547
71257
|
"plural": "centers",
|
|
@@ -93438,7 +93148,11 @@
|
|
|
93438
93148
|
"attributes": []
|
|
93439
93149
|
}],
|
|
93440
93150
|
"attributes": [],
|
|
93441
|
-
"description": "Reverses the authorization hold if the authorization is not captured yet otherwise refunds the payment entirely."
|
|
93151
|
+
"description": "Reverses the authorization hold if the authorization is not captured yet otherwise refunds the payment entirely.",
|
|
93152
|
+
"body": {
|
|
93153
|
+
"type": "payment_refund_form",
|
|
93154
|
+
"attributes": []
|
|
93155
|
+
}
|
|
93442
93156
|
}, {
|
|
93443
93157
|
"method": "POST",
|
|
93444
93158
|
"path": "/:organization/payment/requests/:id/reversal",
|