Get charge data

Retrieves detailed information about a specific charge

Pre-requisite

When integrating with Codapay's API, ensure you adhere to the following standards:

1. Use HTTPS protocol.

2. TLS 1.2 or higher

Reference

Environment	Endpoint Base URL
Sandbox	https://tc-api-card-sandbox.codapayments.com/v1/
Production	https://api-tc.codapayments.com/v1/

Endpoint

GET {Base URL}/direct/charges/{charge_id}

Current Environment Availability

Environment	Is Available?
Sandbox	Yes
Production	Yes

Codapay's APIs support REST web services. By default, the endpoints displayed are RESTful.

Request Parameters

Parameter Name	Data Type	Description	Constraint	Is Required?
charge_id	String	Unique identifier for the charge	Must be a valid charge ID	Yes

Response Parameters

The response contains the charge object.

Parameter Name	Data Type	Description
id	String	Coda’s unique identifier for the charge
created_at	String	Timestamp of when the charge was created
status_code	String	Status of the charge. See the full list of possible statuses here.
error_code	String	The error code for which the charge has failed. See the full list of possibilities here.
error_description	String	The error description for which the charge has failed. See the full list of possibilities here
finalized_at	String	Timestamp of when the charge was finalized
item_code	String	item code
item_name	String	Item name
amount_value	String	Amount of total price
amount_currency	String	Amount Currency
partner_reference	String	Unique identifier for the partner's charge
shopper_agent	JSON Object	A JSON object that contains the shopper’s browser details
setting	JSON Object	A JSON object that contains setting details ( ie partner_webhook_url)
payment_method	JSON Object	A JSON Object that contains payment method details
shopper_action	JSON Object	A JSON object that contains next action for shopper

shopper_agent

Parameter Name	Data Type	Description
ip_address	String	The IP address of the shopper
user_agent	String	User-agent of the shopper
timezone	String	Timezone of shopper
screen_height	String	Height of screen shopper
screen_width	String	Width of screen shopper
colour_depth	String	Color depth of screen shopper
accept_header	String	Accept header of shopper

setting

Parameter Name	Data Type	Description
default_language	String	Preferred language
partner_webhook_url	String	URL for charge notifications (authorization and capture)
card	JSON Object	A JSON object that contains card setting details (ie 3DS, capture ack)

setting -> card

Parameter Name	Data Type	Description
pre_capture_ack_url	String	URL to send the charge capture request
capture_grace_period	Integer	The time period for sending the capture request is in seconds. By default, this is to set 0.
3ds_challenge_window_size	String	Size of the 3D Secure challenge window

payment_method

Parameter Name	Data Type	Description
id	String	Id of payment method
created_at	String	Timestamp of when the payment method was created
type	String	Type of payment method
card	JSON Object	The information on card detail
shopper	JSON Object	Shopper objects that contain shopper details

payment_method -> shopper

Parameter Name	Data Type	Description
id	String	A unique id of shopper
created_at	String	Timestamp of when the shopper was created
status_code	JSON Object	A status of shopper
email	String	email of shopper
zip_code	String	zip code of the shopper

payment_method -> card

Parameter Name	Data Type	Description
id	String	A unique ID of card
created_at	String	Timestamp of when the card was created
country_code	String	Must be a valid ISO 3166-1 alpha-2 country code
holder_name	String	The card holder name
last_four	String	The last 4 digits of card number
expiration_month	String	Expire month of card
expiration_year	String	Expire year of card

shopper_action

Parameter Name	Data Type	Description
id	String	A unique id of shopper action
type	String	A type that shoppers was action with
form	JSON Object	An object that contains form details

shopper_action -> form

Parameter Name	Data Type	Description
id	String	A unique id of form
method	String	A method that requires to submit
action	String	A URL that the partner has to submit to
inputs	List of Input	Details that are required to submit

shopper_action -> form -> inputs -> item

Parameter Name	Data Type	Description
name	String	The name of the input value
value	String	The value of the field
type	String	The type of the value