Charges
Lookup a charge
Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Charges
Lookup a charge
Use this endpoint to retrieve a charge by its unique id.
GET
/
v1
/
charges
/
{id}
curl --request GET \
--url https://{environment}.straddle.io/v1/charges/{id} \
--header 'Authorization: <api-key>'{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paykey": "<string>",
"description": "<string>",
"payment_rail": "ach",
"paykey_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"balance": 123
},
"customer_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"customer_type": "unknown"
},
"amount": 123,
"currency": "<string>",
"payment_date": "2023-12-25",
"consent_type": "internet",
"device": {
"ip_address": "<string>"
},
"external_id": "<string>",
"config": {
"balance_check": "required"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"processed_at": "2023-11-07T05:31:56Z",
"effective_at": "2023-11-07T05:31:56Z",
"status": "created",
"status_details": {
"message": "<string>",
"reason": "insufficient_funds",
"source": "watchtower",
"changed_at": "2023-11-07T05:31:56Z"
},
"status_history": [
{
"reason": "insufficient_funds",
"source": "watchtower",
"message": "<string>",
"code": "<string>",
"changed_at": "2023-11-07T05:31:56Z",
"status": "created"
}
],
"metadata": {}
}
}Authorizations
JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Response
200
text/plain
OK
Available options:
object, array, error, none Id.
Paykey.
Description.
Amount.
Currency.
Payment date.
Available options:
internet, signed External id.
Available options:
required, enabled, disabled Available options:
created, scheduled, failed, cancelled, on_hold, pending, paid, reversed A human-readable description of the status.
Available options:
insufficient_funds, closed_bank_account, invalid_bank_account, invalid_routing, disputed, payment_stopped, owner_deceased, frozen_bank_account, risk_review, fraudulent, duplicate_entry, invalid_paykey, payment_blocked, amount_too_large, too_many_attempts, internal_system_error, user_request, ok, other_network_return, payout_refused Available options:
watchtower, bank_decline, customer_dispute, user_action, system The time the status change occurred.
Status history.
Available options:
insufficient_funds, closed_bank_account, invalid_bank_account, invalid_routing, disputed, payment_stopped, owner_deceased, frozen_bank_account, risk_review, fraudulent, duplicate_entry, invalid_paykey, payment_blocked, amount_too_large, too_many_attempts, internal_system_error, user_request, ok, other_network_return, payout_refused Available options:
watchtower, bank_decline, customer_dispute, user_action, system A human-readable description of the status.
The time the status change occurred.
Available options:
created, scheduled, failed, cancelled, on_hold, pending, paid, reversed The status code if applicable.
Available options:
ach Created at.
Updated at.
Processed at.
Effective at.
curl --request GET \
--url https://{environment}.straddle.io/v1/charges/{id} \
--header 'Authorization: <api-key>'{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paykey": "<string>",
"description": "<string>",
"payment_rail": "ach",
"paykey_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"balance": 123
},
"customer_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"customer_type": "unknown"
},
"amount": 123,
"currency": "<string>",
"payment_date": "2023-12-25",
"consent_type": "internet",
"device": {
"ip_address": "<string>"
},
"external_id": "<string>",
"config": {
"balance_check": "required"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"processed_at": "2023-11-07T05:31:56Z",
"effective_at": "2023-11-07T05:31:56Z",
"status": "created",
"status_details": {
"message": "<string>",
"reason": "insufficient_funds",
"source": "watchtower",
"changed_at": "2023-11-07T05:31:56Z"
},
"status_history": [
{
"reason": "insufficient_funds",
"source": "watchtower",
"message": "<string>",
"code": "<string>",
"changed_at": "2023-11-07T05:31:56Z",
"status": "created"
}
],
"metadata": {}
}
}