Charge
The Charge API allows you to create, retrieve, and update charge objects, as well as manage payment requests. It also handles charging a payment instrument for an order, using a flow that is part of an orchestration, and all of the payment events that occur during the lifecycle of an order.
info
- Authentication required: These endpoints require authentication. To learn how to authenticate, see our authentication documentation.
- Sample requests & responses: To test these endpoints with sample requests, use our Postman collection
- Swagger file: To view definitions for these endpoints, see our swagger file
POST Create Charge
Creates a charge object. It collects the relevant input details from a customer and requests a transaction using their payment details, creating an order.
Endpoint
/charge?action=authorise
Parameters
| Name | Values | Required | Explanation |
|---|---|---|---|
action | authorise | Yes | The initial action for a new charge. |
Sample Messages
Sample Request
{
"order": {
"details_format": "details",
"order_details": {
"service_id": "6cf4a729-cb4f-4e60-8bee-3dee0f7b7a4f",
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
},
"customer": {
"entity_type": "person",
"details_format": "details",
"entity_details": {
"name": {
"full_name": "Company Name"
},
"email": "companyinfo@email.com",
"phone_number": {
"type": "mobile",
"details": {
"unformatted_number": "+913852543512"
}
}
}
}
}
},
"payments": [{
"payment_instrument": {
"details_format": "details",
"instrument_type": "wallet_india",
"instrument_details": {
"instrument": {
"wallet_india_name": "mobikwik"
},
"payer": {
"entity_type": "person",
"details_format": "details",
"entity_details": {
"name": {
"full_name": "Payer Name"
},
"email": "searchpayer-@email.com",
"phone_number": {
"type": "mobile",
"details": {
"unformatted_number": "913852543512"
}
}
}
},
"saved_for_later": true
}
}
}
],
"session": {
"details_format": "details",
"session_type": "web",
"session_details": {
"ip_address": "61.0.255.255",
"start_timestamp": "2023-11-11T18:46:44.935Z",
"finish_timestamp": "2023-11-11T18:46:44.935Z",
"your_session_reference": "session_ref-",
"session": {
"browser": {
"user_agent": "Chrome",
"accept_header": "text/html"
},
"merchant_url": {
"address": "https://www.datameshgroup.com/"
},
"origin_url": {
"address": "https://www.datameshgroup.com/"
},
"redirect_url": {
"address": "https://www.datameshgroup.com/"
},
"payment_frame_size": {
"unit": "pixel",
"width": 640,
"height": 480
}
}
}
}
}
Sample Response
{
"charge_id": "36eccdc4-7809-477f-8057-144016bd7ebb",
"short_id": "EWxl_IJIAON-mkHp",
"order": {
"order_id": "a5ca6b94-98e1-41b6-ba82-5ce751b87c28",
"service_id": "6cf4a729-cb4f-4e60-8bee-3dee0f7b7a4f",
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
},
"customer": {
"entity_id": "77317387-344f-456e-aaec-af4a1b7836e9",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Company Name"
},
"addresses": null,
"email": "companyinfo@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "+913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"orchestration_id": "",
"your_order_reference": "",
"order_line_items": null
},
"payments": [
{
"payment_instrument": {
"instrument_id": "63d2517e-78e2-4454-84d2-f4b793813b69",
"instrument": {
"wallet_india_name": "mobikwik"
},
"payer": {
"entity_id": "a58a4f8d-7ab4-43cf-b4fd-6c6294f132b3",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Payer Name"
},
"addresses": null,
"email": "searchpayer-@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"saved_for_later": true,
"your_instrument_reference": "",
"instrument_type": "wallet_india_instrument"
},
"your_charge_details": null,
"ledger_id": "b8984ca0-7b7b-48fe-a1c2-264eb7e5b719",
"ledger_name": "dmg_india_wallet_india_instrument",
"ledger_type": "card"
}
],
"session": {
"session_id": "0c0a5535-e99a-44e6-8308-d50c6d01d2c7",
"ip_address": "61.0.255.255",
"start_timestamp": "2023-11-11T18:46:44.935Z",
"finish_timestamp": "",
"session": {
"language": "",
"device_identifier": "",
"browser": {
"user_agent": "Chrome",
"accept_header": "text/html",
"java_enabled": false,
"javascript_enabled": false,
"language": "",
"time_zone_offset": 0
},
"your_success_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"your_failure_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"redirect_system_urls": [
{
"url_type": "OTP",
"url": {
"address": "https://api.psp.example/v1/payments/MyBzbxoZQWKIic/authenticate",
"call_type": "GET",
"query_parameters": null,
"Headers": ""
},
"url_description": ""
}
],
"cookie": "",
"payment_frame_size": {
"unit": "pixel",
"width": 640,
"height": 480
}
},
"your_session_reference": ""
},
"your_charge_reference": "",
"status": {
"status": "pending_authorisation"
},
"event": {
"event_number": 0,
"action": "authorise",
"requested_balance": 0,
"requested_amount": 0,
"resulting_balance": 0,
"resulting_amount": 0,
"source": "api",
"status": "pending_authorisation"
},
"summary_amounts": {
"original_order_total": 1000,
"current_order_total": 1000,
"funded_amount": 0,
"canceled_amount": 0,
"completed_amount": 0,
"refunded_amount": 0,
"settled_amount": 0,
"disputed_amount": 0,
"reconciled_amount": 0,
"reversed_amount": 0,
"out_of_balance_amounts": []
},
"psp_responses": [
{
"psp_id": "pay_MyBzbxoZQWKIic",
"psp_name": "<psp-name>",
"type": "wallet_india_instrument",
"details": {
"payment_instrument_response": {
"lost_stolen_card_flag": false,
"prepaid_details": {
"prepaid_card_flag": false,
"prepaid_available_balance": {
"value": 0,
"currency": {
"currency_code": ""
}
}
},
"international_card_flag": false
},
"payment_verification_response": {
"address_verification_response": {
"status_code": "",
"status_message": ""
},
"card_verification_response": {
"status_code": "",
"status_message": ""
},
"digital_verification_response": {
"status_code": "",
"status_message": ""
},
"physical_verification_response": {
"status_code": "",
"status_message": ""
}
},
"raw_message": null,
"status_code": "200",
"charge_responses": {
"authorization_id": "",
"acquirer_response_code": "",
"network_unique_id": ""
}
},
"response_time": ""
}
]
}
GET Charge
Provides details of a given charge using the charge ID or short ID. Noting that short ID is an alternative 16 character shorten reference that can be used to refer to the Charge object within the payment gateway.
Endpoint
/charge/{charge_id} or /charge/{short_id}
Parameters
| Name | Values | Required | Explanation |
|---|---|---|---|
charge_id or short_id | {charge_id} or {short_id} | Yes | The charge ID or short ID for which information will be fetched. |
Sample Messages
Sample Response
{
"charge_id": "77009673-4db1-4901-bd30-8da703223bab",
"short_id": "EWxl_IJIAON-mkHp",
"order": {
"order_id": "bac4a315-281f-4a57-9ea1-ed9812abbf12",
"service_id": "6cf4a729-cb4f-4e60-8bee-3dee0f7b7a4f",
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
},
"customer": {
"entity_id": "971d4998-ef4b-4f30-80d2-4122d83a6164",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Company Name"
},
"addresses": null,
"email": "companyinfo@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "+913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"orchestration_id": "",
"your_order_reference": "",
"order_line_items": null
},
"payments": [
{
"payment_instrument": {
"instrument_id": "ba7f5404-36b1-48b9-94b5-f8dee4bd68fb",
"instrument": {
"expiration_date": "03/30",
"card_function": "",
"country": "",
"brand": "",
"card_last_four": "1111"
},
"payer": {
"entity_id": "2e35d7a3-2c95-4ff7-94f4-aa42fc5be8fe",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Payer Name"
},
"addresses": null,
"email": "searchpayer-test@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"saved_for_later": true,
"your_instrument_reference": "",
"instrument_type": "card_instrument"
},
"your_charge_details": null,
"ledger_id": "8975e114-59cf-4e77-bc22-9b9b481932ea",
"ledger_name": "dmg_india_card_instrument",
"ledger_type": "card"
}
],
"session": {
"session_id": "34688fc6-62ed-4f88-b2f5-c021ce737740",
"ip_address": "61.0.255.255",
"start_timestamp": "2023-11-11T18:46:44.935Z",
"finish_timestamp": "",
"session": {
"language": "",
"device_identifier": "",
"browser": {
"user_agent": "Chrome",
"accept_header": "text/html",
"java_enabled": false,
"javascript_enabled": false,
"language": "",
"time_zone_offset": 0
},
"your_success_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"your_failure_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"redirect_system_urls": [
{
"url_type": "OTP",
"url": {
"address": "https://api.psp.example/v1/payments/MyBz0ulZ0OaLwL/authenticate",
"call_type": "GET",
"query_parameters": null,
"Headers": ""
},
"url_description": ""
}
],
"cookie": "",
"payment_frame_size": {
"unit": "pixel",
"width": 640,
"height": 480
}
},
"your_session_reference": ""
},
"your_charge_reference": "",
"status": {
"status": "not_completed"
},
"event": {
"event_number": 2,
"action": "complete",
"requested_balance": 0,
"requested_amount": 0,
"resulting_balance": 0,
"resulting_amount": 0,
"source": "api",
"status": "not_completed"
},
"summary_amounts": {
"original_order_total": 1000,
"current_order_total": 1000,
"funded_amount": 0,
"canceled_amount": 0,
"completed_amount": 1000,
"refunded_amount": 0,
"settled_amount": 0,
"disputed_amount": 0,
"reconciled_amount": 0,
"reversed_amount": 0,
"out_of_balance_amounts": []
},
"psp_responses": [
{
"psp_id": "pay_MyBz0ulZ0OaLwL",
"psp_name": "<psp-name>",
"type": "card_instrument",
"details": {
"payment_instrument_response": {
"lost_stolen_card_flag": false,
"prepaid_details": {
"prepaid_card_flag": false,
"prepaid_available_balance": {
"value": 0,
"currency": {
"currency_code": ""
}
}
},
"international_card_flag": false
},
"payment_verification_response": {
"address_verification_response": {
"status_code": "",
"status_message": ""
},
"card_verification_response": {
"status_code": "",
"status_message": ""
},
"digital_verification_response": {
"status_code": "",
"status_message": ""
},
"physical_verification_response": {
"status_code": "",
"status_message": ""
}
},
"raw_message": null,
"status_code": "400",
"charge_responses": {
"authorization_id": "",
"acquirer_response_code": "",
"network_unique_id": ""
}
},
"response_time": "",
"psp_error": {
"error_class": 4,
"error_type": "external_system_error",
"error_data": null,
"error_retryable": true,
"error_message": "Only payments which have been authorized and not yet captured can be captured",
"http_code": 203
}
}
],
"connector_error_type": "external_system_error",
"error_message": "Only payments which have been authorized and not yet captured can be captured"
}
GET Charge Search with Order
Returns one or more charges that are linked to an Order object
Endpoint
/charge/search
Parameters
| Name | Values | Required | Description |
|---|---|---|---|
order_token | string | Yes | A unique reference to an order_token. |
limit | int | No | Maximum number of charges to return. |
offset | int | No | The number of items to skip before returning the results |
Sample Messages
Sample Response
{
"max_offset": 0,
"offset": 0,
"results": [
{
"charge_id": "77009673-4db1-4901-bd30-8da703223bab",
"short_id": "EWxl_IJIAON-mkHp",
"order": {
"order_id": "bac4a315-281f-4a57-9ea1-ed9812abbf12",
"service_id": "6cf4a729-cb4f-4e60-8bee-3dee0f7b7a4f",
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
},
"customer": {
"entity_id": "971d4998-ef4b-4f30-80d2-4122d83a6164",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Company Name"
},
"addresses": null,
"email": "companyinfo@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "+913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"orchestration_id": "",
"your_order_reference": "",
"order_line_items": null
},
"payments": [
{
"payment_instrument": {
"instrument_id": "ba7f5404-36b1-48b9-94b5-f8dee4bd68fb",
"instrument": {
"expiration_date": "03/30",
"card_function": "",
"country": "",
"brand": "",
"card_last_four": "1111"
},
"payer": {
"entity_id": "2e35d7a3-2c95-4ff7-94f4-aa42fc5be8fe",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Payer Name"
},
"addresses": null,
"email": "searchpayer-test@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"saved_for_later": true,
"your_instrument_reference": "",
"instrument_type": "card_instrument"
},
"your_charge_details": null,
"ledger_id": "8975e114-59cf-4e77-bc22-9b9b481932ea",
"ledger_name": "dmg_india_card_instrument",
"ledger_type": "card"
}
],
"session": {
"session_id": "34688fc6-62ed-4f88-b2f5-c021ce737740",
"ip_address": "61.0.255.255",
"start_timestamp": "2023-11-11T18:46:44.935Z",
"finish_timestamp": "",
"session": {
"language": "",
"device_identifier": "",
"browser": {
"user_agent": "Chrome",
"accept_header": "text/html",
"java_enabled": false,
"javascript_enabled": false,
"language": "",
"time_zone_offset": 0
},
"your_success_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"your_failure_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"redirect_system_urls": [
{
"url_type": "OTP",
"url": {
"address": "https://api.psp.example/v1/payments/MyBz0ulZ0OaLwL/authenticate",
"call_type": "GET",
"query_parameters": null,
"Headers": ""
},
"url_description": ""
}
],
"cookie": "",
"payment_frame_size": {
"unit": "pixel",
"width": 640,
"height": 480
}
},
"your_session_reference": ""
},
"your_charge_reference": "",
"status": {
"status": "not_completed"
},
"event": {
"event_number": 2,
"action": "complete",
"requested_balance": 0,
"requested_amount": 0,
"resulting_balance": 0,
"resulting_amount": 0,
"source": "api",
"status": "not_completed"
},
"summary_amounts": {
"original_order_total": 1000,
"current_order_total": 1000,
"funded_amount": 0,
"canceled_amount": 0,
"completed_amount": 1000,
"refunded_amount": 0,
"settled_amount": 0,
"disputed_amount": 0,
"reconciled_amount": 0,
"reversed_amount": 0,
"out_of_balance_amounts": []
},
"psp_responses": [
{
"psp_id": "pay_MyBz0ulZ0OaLwL",
"psp_name": "<psp-name>",
"type": "card_instrument",
"details": {
"payment_instrument_response": {
"lost_stolen_card_flag": false,
"prepaid_details": {
"prepaid_card_flag": false,
"prepaid_available_balance": {
"value": 0,
"currency": {
"currency_code": ""
}
}
},
"international_card_flag": false
},
"payment_verification_response": {
"address_verification_response": {
"status_code": "",
"status_message": ""
},
"card_verification_response": {
"status_code": "",
"status_message": ""
},
"digital_verification_response": {
"status_code": "",
"status_message": ""
},
"physical_verification_response": {
"status_code": "",
"status_message": ""
}
},
"raw_message": null,
"status_code": "400",
"charge_responses": {
"authorization_id": "",
"acquirer_response_code": "",
"network_unique_id": ""
}
},
"response_time": "",
"psp_error": {
"error_class": 4,
"error_type": "external_system_error",
"error_data": null,
"error_retryable": true,
"error_message": "Only payments which have been authorized and not yet captured can be captured",
"http_code": 203
}
}
]
}
]
}
POST Charge Next Action
Takes the next action with a previously created charge.
Endpoint
/charge/{charge_id} or /charge/{short_id}
Parameters
| Name | Values | Required | Explanation |
|---|---|---|---|
charge_id or short_id | {charge_id} or {short_id} | Yes | The charge ID or short ID for which the next action will be taken |
action | validate, authorise, complete, cancel, refund, update | Yes | The next action that will be taken |
Sample Messages
Sample Request
{
"order": {
"details_format": "details",
"order_details": {
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
}
}
}
}
Sample Response
{
"charge_id": "f65b7211-a841-4609-85b9-72e2ca95652d",
"short_id": "EWxl_IJIAON-mkHp",
"order": {
"order_id": "96cff658-5133-48db-af7c-ac42555f52c1",
"service_id": "6cf4a729-cb4f-4e60-8bee-3dee0f7b7a4f",
"order_amount": {
"value": 1000,
"currency": {
"currency_code": "INR"
}
},
"customer": {
"entity_id": "bab6f399-c3a4-4c65-b517-3bf595e15827",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Company Name"
},
"addresses": null,
"email": "companyinfo@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "+913852543512",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"orchestration_id": "",
"your_order_reference": "",
"order_line_items": null
},
"payments": [
{
"payment_instrument": {
"instrument_id": "44b2f141-4ef2-4c92-8d05-2713e84fce88",
"instrument": {
"expiration_date": "03/30",
"card_function": "",
"country": "",
"brand": "",
"card_last_four": "1111"
},
"payer": {
"entity_id": "43e0bde2-12c7-4e5d-8571-cc56476c5a90",
"your_entity_reference": "",
"entity_type": "person",
"entity_details": {
"name": {
"first": "",
"middle": "",
"last": "",
"suffix": "",
"prefix": "",
"full_name": "Payer Name"
},
"addresses": null,
"email": "searchpayer-123@email.com",
"phone_number": {
"type": "mobile",
"details": {
"country_code": "",
"unformatted_number": "9112345678",
"formatted_number": ""
},
"your_phone_number_reference": ""
}
}
},
"saved_for_later": true,
"your_instrument_reference": "",
"instrument_type": "card_instrument"
},
"your_charge_details": null,
"ledger_id": "50e9fdc9-8d72-43eb-8b76-7c65cc0fc4b2",
"ledger_name": "dmg_india_card_instrument",
"ledger_type": "card"
}
],
"session": {
"session_id": "885cfc4b-7d64-4409-9530-a5d034d17a2f",
"ip_address": "61.0.255.255",
"start_timestamp": "2023-11-11T18:46:44.935Z",
"finish_timestamp": "",
"session": {
"language": "",
"device_identifier": "",
"browser": {
"user_agent": "Chrome",
"accept_header": "text/html",
"java_enabled": false,
"javascript_enabled": false,
"language": "",
"time_zone_offset": 0
},
"your_success_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"your_failure_return_url": {
"address": "",
"call_type": "",
"query_parameters": null,
"Headers": ""
},
"redirect_system_urls": [
{
"url_type": "OTP",
"url": {
"address": "https://api.psp.example/v1/payments/MyC7fkkDs9D0vo/authenticate",
"call_type": "GET",
"query_parameters": null,
"Headers": ""
},
"url_description": ""
}
],
"cookie": "",
"payment_frame_size": {
"unit": "pixel",
"width": 640,
"height": 480
}
},
"your_session_reference": ""
},
"your_charge_reference": "",
"status": {
"status": "completed"
},
"event": {
"event_number": 1,
"action": "complete",
"requested_balance": 0,
"requested_amount": 0,
"resulting_balance": 0,
"resulting_amount": 0,
"source": "api",
"status": "completed"
},
"summary_amounts": {
"original_order_total": 1000,
"current_order_total": 1000,
"funded_amount": 0,
"canceled_amount": 0,
"completed_amount": 1000,
"refunded_amount": 0,
"settled_amount": 0,
"disputed_amount": 0,
"reconciled_amount": 0,
"reversed_amount": 0,
"out_of_balance_amounts": []
},
"psp_responses": [
{
"psp_id": "pay_MyC7fkkDs9D0vo",
"psp_name": "<psp-name>",
"type": "card_instrument",
"details": {
"payment_instrument_response": {
"lost_stolen_card_flag": false,
"prepaid_details": {
"prepaid_card_flag": false,
"prepaid_available_balance": {
"value": 0,
"currency": {
"currency_code": ""
}
}
},
"international_card_flag": false
},
"payment_verification_response": {
"address_verification_response": {
"status_code": "",
"status_message": ""
},
"card_verification_response": {
"status_code": "",
"status_message": ""
},
"digital_verification_response": {
"status_code": "",
"status_message": ""
},
"physical_verification_response": {
"status_code": "",
"status_message": ""
}
},
"raw_message": {
"details": {
"raw_message": {
"id": "pay_MyC7fkkDs9D0vo",
"entity": "payment",
"amount": 1000,
"currency": "INR",
"status": "captured",
"order_id": null,
"invoice_id": null,
"international": false,
"method": "card",
"amount_refunded": 0,
"refund_status": null,
"captured": true,
"description": null,
"card_id": "card_MyC7fqC5Nc28ng",
"card": {
"id": "card_MyC7fqC5Nc28ng",
"entity": "card",
"name": "",
"last4": "1111",
"network": "Visa",
"type": "debit",
"issuer": null,
"international": false,
"emi": false,
"sub_type": "consumer",
"token_iin": null
},
"bank": null,
"wallet": null,
"vpa": null,
"email": "searchpayer-123@email.com",
"contact": "+919112345678",
"token_id": "token_MyC7g4CjGyr0jA",
"notes": {
"LedgerID": "50e9fdc9-8d72-43eb-8b76-7c65cc0fc4b2"
},
"fee": 20,
"tax": 0,
"error_code": null,
"error_description": null,
"error_source": null,
"error_step": null,
"error_reason": null,
"acquirer_data": {
"auth_code": "557252"
},
"created_at": 1699493406
},
"status_code": "200"
},
"psp_name": "<psp-name>",
"type": "card_instrument"
},
"status_code": "200",
"charge_responses": {
"authorization_id": "",
"acquirer_response_code": "",
"network_unique_id": ""
}
},
"response_time": ""
}
]
}
HTTP Response Codes
Below is a table summarizing the various HTTP response codes and their descriptions for the Charge API.
| HTTP Status Code | Response Schema | Description |
|---|---|---|
| 200 | Charge | The charge response provides the status of the most recent charge event and ledger balances and tokens for the payment, order, and settlement (if available). |
| 201 | Charge Pending | The pending charge response provides the pending status of the most recent charge event. |
| 202 | Charge Money Error | The money error charge response provides error information about the most recent charge event, which had a money error. Please review the error fields to determine how to resolve this error. |
| 203 | Charge Connectivity Error | The connector error charge response provides error information about the most recent charge event, which had a connector error. Please review the error fields to determine how to resolve this error. |
| 211 | Charge Data Error | The charge error response provides error information and the status of the charge as well as balances for the payment, order, and settlement (if available) ledgers. Also provided are the token references for the associated payment, order, session, and entity tokens. |
| 400 | Charge Request Error | The request error charge response provides error information about the most recent API request, which contained a schema error. Please review the error fields to determine how to resolve this error. |
| 500 | System Error | An error occurred either within /charge or externally in a system Connected to /charge. Please notify DMG via ecomm@datameshgroup.com. |