US API Reference

Solidgate API, which also includes version V1, is a payment gateway API that enables merchants to securely process and manage transactions, including card payments and alternative payment methods.

Payments https://pay.solidgate.us/api/v3

Great care is taken to ensure that changes to the Solidgate APIs do not impact existing integrations. Below are the types of changes considered to be backward-compatible:

New fields Inclusion of new, optional request fields or parameters to existing APIs.

Response modifications Addition of new fields to existing API responses.

HTTP headers Introduction of new, optional HTTP request headers or new HTTP response headers.

String length Increase in the length of existing string field values.

Identifier format Alteration or removal of prefixes from existing identifiers.

Webhook events Introduction of new webhook event types (explicit opt-in required).

Webhook schema Addition of new fields to existing webhook event schemas.

Versioning Support for API versioning exists, with maintenance of older versions up to a certain point. Advanced notice will be provided for deprecation.

Rate limiting Communication regarding changes to rate limiting will occur with at least one month's advance notice.

Enhance your understanding with our detailed payment guide.

Support: support@solidgate.com

For mass operations, it is advised to use requests with a reasonable rate limiter established (live mode - 100 rps, test mode - 25 rps).

Order status Webhook

Webhooks allow merchants to securely receive real-time notifications about card order status changes, such as from processing to declined.

These notifications can automatically trigger actions or updates in their own systems based on these events.

header Parameters

merchant	string Example: wh_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from the customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to the customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
redirect_url	string <= 255 characters URL to which the customer should be redirected to complete the payment.
	object The Map of transactions where the keys are transaction identifiers.
	object Customer payment source.

Responses

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"redirect_url": "https://www.solidgate.com",
"transactions": {"<transaction_id_value_#1>": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
}
},
"payment_source": {"type": "card",
"card_number": "2223 0880 4840 0011",
"card_holder_name": "Nazar Kalinichenko",
"card_exp_month": 3,
"card_exp_year": 2029,
"card_cvv": "998",
"billing_address": {"line1": "2B",
"line2": "90 Tottenham Court Road",
"city": "New York",
"state": "WA",
"zip": "12345",
"country": "USA"
}
}
}

Form initialization

Initiating a payment form, this function facilitates customer interaction for payments and securely commences a transaction, supplying all essential order and payment process information.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency required	string = 3 characters The three-letter ISO currency code of the order.
order_description required	string <= 255 characters A description of the order.
order_date	string <date-time> <= 50 characters Date of order creation defined by the merchant.
order_items	string <= 255 characters List and description of the items included in the order.
order_number	integer The index number of order per customer.
subscription_product_id	string <uuid> = 36 characters The product ID of the customer’s subscription is provided by Solidgate.
required	object This is an object, representing the parameters related to an automatic settlement process.
website	string The website URL where the order was placed.
processing_mid required	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
callback_url	string <= 255 characters URL to which the payment result will be sent.
fail_url	string <= 255 characters URL to redirect the customer to in case of failed payment.
success_url	string <= 255 characters URL to redirect the customer to in case of successful payment.
dynamic_descriptor	string <= 50 characters Dynamic descriptor is a short description of the product or service, which is displayed on the cardholder’s bank statement.
	object Returns information related to the processing of the payment.
required	object Details of the customer to associate with the source.
	object Details of the payment form to associate with the source.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters The unique identifier associated with a specific order.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string <= 3 characters The currency of the transaction.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
	object The object contains the URL that directs customers to the payment completion.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"order_description": "Premium package",
"order_date": "2015-12-21 11:21:30",
"order_items": "item 1 x 10, item 2 x 30",
"order_number": 9,
"subscription_product_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"settle": {"delay_hours": 24
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"callback_url": "https://www.solidgate.com",
"fail_url": "https://example.com/fail",
"success_url": "https://example.com/success",
"dynamic_descriptor": "payhere.com",
"three_ds": {"force": false,
"attempt_non_secure": false
},
"customer": {"user_id": "1672068260960AlexKhoRecurring11",
"email": "user@solidgate.us",
"ip_address": "8.8.8.8",
"first_name": "Alex",
"last_name": "Kho",
"phone_number": "+1415 555 2671",
"date_of_birth": "1990-01-01",
"ip_country": "USA",
"delivery_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
},
"payment_form": {"language": "en"
}
}

Response samples

Content type

application/json

Example

Success

{"order_id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"amount": 100,
"currency": "USD",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"payment_form": {"form_url": "https://www.solidgate.com"
}
}

Charge

Basic operation of funds withdrawal from cardholder’s account. This operation can be performed with additional cardholder verification via 3D Secure. When the operation is successfully finalized, cardholder data is tokenized so that the subsequent payments can be made via token (tokenized payment).

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency required	string = 3 characters The three-letter ISO currency code of the order.
order_description required	string <= 255 characters A description of the order.
order_date	string <date-time> <= 50 characters Date of order creation defined by the merchant.
order_items	string <= 255 characters List and description of the items included in the order.
order_number	integer The index number of order per customer.
subscription_product_id	string <uuid> = 36 characters The product ID of the customer’s subscription is provided by Solidgate.
required	object This is an object, representing the parameters related to an automatic settlement process.
website	string The website URL where the order was placed.
processing_mid required	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
callback_url	string <= 255 characters URL to which the payment result will be sent.
fail_url	string <= 255 characters URL to redirect the customer to in case of failed payment.
success_url	string <= 255 characters URL to redirect the customer to in case of successful payment.
	object <= 10 properties Metadata is useful for storing additional, structured information about an object.
dynamic_descriptor	string <= 50 characters Dynamic descriptor is a short description of the product or service, which is displayed on the cardholder’s bank statement.
	object Returns information related to the processing of the payment.
	object Recurring payments allow merchants to charge customers for goods or services on a prearranged schedule.
required	object Details of the customer to associate with the source.
required	object Customer payment source.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from the customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to the customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
redirect_url	string <= 255 characters URL to which the customer should be redirected to complete the payment.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"order_description": "Premium package",
"order_date": "2015-12-21 11:21:30",
"order_items": "item 1 x 10, item 2 x 30",
"order_number": 9,
"subscription_product_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"settle": {"delay_hours": 24
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"callback_url": "https://www.solidgate.com",
"fail_url": "https://example.com/fail",
"success_url": "https://example.com/success",
"order_metadata": {"coupon_code": "NY2024",
"partner_id": "123989"
},
"dynamic_descriptor": "payhere.com",
"three_ds": {"force": false,
"attempt_non_secure": false,
"mpi_data": {"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"ds_transaction_id": 1234567890,
"eci": 5,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
}
},
"recurring": {"type": "1-click"
},
"customer": {"user_id": "1672068260960AlexKhoRecurring11",
"email": "user@solidgate.us",
"ip_address": "8.8.8.8",
"first_name": "Alex",
"last_name": "Kho",
"phone_number": "+1415 555 2671",
"date_of_birth": "1990-01-01",
"ip_country": "USA",
"delivery_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
},
"payment_source": {"type": "card",
"card_number": "2223 0880 4840 0011",
"card_holder_name": "Nazar Kalinichenko",
"card_exp_month": 3,
"card_exp_year": 2029,
"card_cvv": "998",
"billing_address": {"line1": "2B",
"line2": "90 Tottenham Court Road",
"city": "New York",
"state": "WA",
"zip": "12345",
"country": "USA"
}
}
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"redirect_url": "https://www.solidgate.com",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Apple Pay

An API request for Apple Pay allows a merchant to initiate an Apple Pay transaction, by sending a request to the Apple Pay API with the required parameters such as amount, currency, and order ID, which will be processed, and the response will be sent back with the transaction details.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency required	string = 3 characters The three-letter ISO currency code of the order.
order_description required	string <= 255 characters A description of the order.
order_date	string <date-time> <= 50 characters Date of order creation defined by the merchant.
order_items	string <= 255 characters List and description of the items included in the order.
order_number	integer The index number of order per customer.
subscription_product_id	string <uuid> = 36 characters The product ID of the customer’s subscription is provided by Solidgate.
required	object This is an object, representing the parameters related to an automatic settlement process.
website	string The website URL where the order was placed.
processing_mid required	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
callback_url	string <= 255 characters URL to which the payment result will be sent.
	object <= 10 properties Metadata is useful for storing additional, structured information about an object.
required	object Details of the customer to associate with the source.
required	object Customer payment source.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from the customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to the customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
redirect_url	string <= 255 characters URL to which the customer should be redirected to complete the payment.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"order_description": "Premium package",
"order_date": "2015-12-21 11:21:30",
"order_items": "item 1 x 10, item 2 x 30",
"order_number": 9,
"subscription_product_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"settle": {"delay_hours": 24
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"callback_url": "https://www.solidgate.com",
"order_metadata": {"coupon_code": "NY2024",
"partner_id": "123989"
},
"customer": {"user_id": "1672068260960AlexKhoRecurring11",
"email": "user@solidgate.us",
"ip_address": "8.8.8.8",
"first_name": "Alex",
"last_name": "Kho",
"phone_number": "+1415 555 2671",
"date_of_birth": "1990-01-01",
"ip_country": "USA",
"delivery_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
},
"payment_source": {"type": "apple-pay",
"signature": "M2E3OTkyNzcz...xMmExODI4",
"version": 1,
"data": "qIEHeSmLKw3C5...ZIuf2oPeLhQ1DCaQj",
"header": {"transactionId": "7126df4ff8ac61dc60278b5cd549cc98d16b8f41",
"publicKeyHash": "mQaQhyhrXX3ZDSQv...ByX0iii0MVHthSQiXQ=",
"wrappedKey": "AHIJKLMNOPMBCC98FYs2RS8hJlmOPcZKQUZbxFGg==",
"ephemeralPublicKey": "BDFJKLMNOPMBCC98FYs2RS8hJlmOPcZKQUZbxFGg==",
"applicationData": "ADFJKLMNOPMBCC98FYs2RS8hJlmOPcZKQUZbxFGg=="
},
"network": "VISA"
}
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"redirect_url": "https://www.solidgate.com",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Google Pay

An API request for Google Pay allows a merchant to initiate an Google Pay transaction, by sending a request to the Google Pay API with the required parameters such as amount, currency, and order ID, which will be processed, and the response will be sent back with the transaction details.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency required	string = 3 characters The three-letter ISO currency code of the order.
order_description required	string <= 255 characters A description of the order.
order_date	string <date-time> <= 50 characters Date of order creation defined by the merchant.
order_items	string <= 255 characters List and description of the items included in the order.
order_number	integer The index number of order per customer.
subscription_product_id	string <uuid> = 36 characters The product ID of the customer’s subscription is provided by Solidgate.
required	object This is an object, representing the parameters related to an automatic settlement process.
website	string The website URL where the order was placed.
processing_mid required	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
callback_url	string <= 255 characters URL to which the payment result will be sent.
	object <= 10 properties Metadata is useful for storing additional, structured information about an object.
required	object Details of the customer to associate with the source.
required	object Customer payment source.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from the customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to the customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
redirect_url	string <= 255 characters URL to which the customer should be redirected to complete the payment.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"order_description": "Premium package",
"order_date": "2015-12-21 11:21:30",
"order_items": "item 1 x 10, item 2 x 30",
"order_number": 9,
"subscription_product_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"settle": {"delay_hours": 24
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"callback_url": "https://www.solidgate.com",
"order_metadata": {"coupon_code": "NY2024",
"partner_id": "123989"
},
"customer": {"user_id": "1672068260960AlexKhoRecurring11",
"email": "user@solidgate.us",
"ip_address": "8.8.8.8",
"first_name": "Alex",
"last_name": "Kho",
"phone_number": "+1415 555 2671",
"date_of_birth": "1990-01-01",
"ip_country": "USA",
"delivery_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
},
"payment_source": {"type": "google-pay",
"signature": "M2E3OTkyNzcz...xMmExODI4",
"signedMessage": "encryptedMessage......t1+Eu003d",
"protocolVersion": "ECv1"
}
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"redirect_url": "https://www.solidgate.com",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Settle

Operation is used for settling of authorization transaction that was previously performed.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from The customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to The customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of The customer’s subscription provided by Solidgate.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Refund

Request for transferring funds back to the cardholder. Refunds can be made only for approved transactions.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id required	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount required	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from The customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to The customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on The customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of The customer’s subscription provided by Solidgate.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Void

Operation is used for voiding of previously performed authorization transactions.

header Parameters

merchant	string Example: api_pk_7b197...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id

required

string <= 255 characters

Order identifier defined by the merchant, which can be used later to find this payment.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from The customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to The customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of The customer’s subscription provided by Solidgate.
	object Returns information related to the processing of the payment.
	object The payment source of the transaction.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55"
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"transaction": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
},
"payment_source": {"type": "card",
"card_id": "22733af4-f6c6-4368-b7d0-98aeb0253a57",
"token_expiration_date": "2025-12-31",
"payment_token": "2734bf2cb7735de6b0987e3716aab3993c73e6ca24345a449890c18ca9ef520ee93b8c183800a14c741bd8469a02e4c0e7d8",
"issuer": "Visa",
"bin": "411111",
"card_brand": "Visa",
"card_type": "credit",
"card_exp_month": 12,
"card_exp_year": 2025,
"card_holder_name": "John Doe",
"masked_card_number": "411111******1111",
"issuer_country": "USA",
"billing_address": {"line1": "123 Main St.",
"line2": "Apt. 123",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
}
}
}

Check order status

Is a request for getting current order status.

header Parameters

merchant	string Example: api_pk_7b194...ba108f842 A unique Public Key is provided upon registration and must be shared for identification purposes.
signature	string Example: M2E3OTkyNzcz...xMmExODI4 Signature of request. It allows verifying whether the request from the merchant is genuine on the payment gateway server.

Request Body schema: application/json

order_id

required

string <= 255 characters

Order identifier defined by the merchant, which can be used later to find this payment.

Responses

Response Schema: application/json

Any of

order_id	string <= 255 characters Order identifier defined by the merchant, which can be used later to find this payment.
amount	integer Order amount in its smallest currency unit (cent for euro). For instance, 1020 means 10 EUR and 20 cents.
currency	string = 3 characters The three-letter ISO currency code of the order.
refunded_amount	integer The amount of the order that has been refunded.
settled_amount	integer The amount of the order that has been settled.
status	string The current status of the order. `authorized` - Indicates the customer's payment method has been verified and possesses sufficient funds for the order. `settled` - Signifies the transaction's completion with funds having been transferred from the customer to the merchant. `declined` - Marks an order where the transaction wasn't approved, potentially due to payment issues or bank decisions. `created` - Refers to an order that's been initiated in the system, though the payment process hasn't begun. `processing` - Denotes an order currently undergoing the necessary steps to conclude the transaction. `refunded` - Shows that the initial transaction funds have been returned to the customer. `voided` - Used for an order that's been cancelled before settlement, which releases any authorization hold on the customer's account.
descriptor	string The descriptor that will be displayed on the customer's bank statement.
	object This is an object, representing the parameters related to a declined order.
	object Returns the payment's risk assessment results.
avs_check	string <= 1 characters The result of the address verification system (AVS) check.
cvv_check	string <= 1 characters The result of the card verification value (CVV) check.
	object Returns information related to the processing of the payment.
website	string The website URL where the order was placed.
processing_mid	string <= 255 characters Use the processing MID parameter to route order on the chosen path.
subscription_id	string <uuid> = 36 characters The ID of the customer’s subscription provided by Solidgate.
redirect_url	string <= 255 characters URL to which the customer should be redirected to complete the payment.
	object The Map of transactions where the keys are transaction identifiers.
	object Customer payment source.

Request samples

Payload

Content type

application/json

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55"
}

Response samples

Content type

application/json

Example

Success

{"order_id": "923bb4e6-4a5f-41ec-81fb-28eb8a152e55",
"amount": 100,
"currency": "USD",
"refunded_amount": 100,
"settled_amount": 100,
"status": "settled",
"descriptor": "Solidgate",
"decline": {"code": 100,
"message": "Insufficient funds"
},
"risk": {"decision": "reject"
},
"avs_check": "Y",
"cvv_check": "Y",
"three_ds": {"enrolled": "Y",
"authentication_result": "Y",
"cavv": "AAABBJg0VhI0Vni...Q2Q==",
"eci": null,
"version": "2.1.0",
"xid": "eJxVUttOwzAM/ZW...Q2Q=="
},
"website": "https://www.solidgate.com",
"processing_mid": "b0651d75db2",
"subscription_id": "83b19018-cbc4-45f0-899a-dda84fd2705e",
"redirect_url": "https://www.solidgate.com",
"transactions": {"<transaction_id_value_#1>": {"id": "83b19018-cbc4-4df0-899a-dda84fd2705e",
"created_at": "2020-01-01 00:00:00",
"updated_at": "2020-01-01 00:00:00",
"operation": "sale",
"status": "verify",
"amount": 100,
"currency": "USD",
"auth_code": 123456,
"arn": 1.2345678901234568e+22,
"refund_reason_code": "0012"
}
},
"payment_source": {"type": "card",
"card_number": "2223 0880 4840 0011",
"card_holder_name": "Nazar Kalinichenko",
"card_exp_month": 3,
"card_exp_year": 2029,
"card_cvv": "998",
"billing_address": {"line1": "2B",
"line2": "90 Tottenham Court Road",
"city": "New York",
"state": "WA",
"zip": "12345",
"country": "USA"
}
}
}