Charges
Creates a charge
REST API
Charges
Creates a charge
POST
/
charges
Copy
Ask AI
curl --request POST \
--url https://api.commerce.coinbase.com/charges \
--header 'Content-Type: application/json' \
--header 'X-CC-Api-Key: <api-key>' \
--data '{
"buyer_locale": "<string>",
"cancel_url": "<string>",
"checkout_id": "<string>",
"local_price": {
"amount": "<string>",
"currency": "<string>"
},
"metadata": {
"custom_field": "internal_id",
"custom_field_two": "anything"
},
"pricing_type": "fixed_price",
"redirect_url": "<string>"
}'
Copy
Ask AI
{
"brand_color": "<string>",
"brand_logo_url": "<string>",
"charge_kind": "WEB3",
"checkout": {
"id": "<string>"
},
"code": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"hosted_url": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organization_name": "<string>",
"pricing": {
"local": {
"amount": "<string>",
"currency": "<string>"
},
"settlement": {
"amount": "<string>",
"currency": "<string>"
}
},
"pricing_type": "fixed_price",
"redirects": {
"cancel_url": "<string>",
"success_url": "<string>",
"will_redirect_after_success": true
},
"support_email": "jsmith@example.com",
"third_party_provider": "<string>",
"timeline": [
{
"status": "COMPLETED",
"time": "2023-11-07T05:31:56Z"
}
],
"web3_data": {
"failure_events": [
{
"input_token_address": "<string>",
"network_fee_paid": "<string>",
"reason": "<string>",
"sender": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"tx_hsh": "<string>"
}
],
"success_events": [
{
"finalized": true,
"input_token_address": "<string>",
"input_token_amount": "<string>",
"network_fee_paid": "<string>",
"recipient": "<string>",
"sender": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"tx_hsh": "<string>"
}
],
"transfer_intent": {
"call_data": {
"deadline": "<string>",
"fee_amount": "<string>",
"id": "<string>",
"operator": "<string>",
"prefix": "<string>",
"recipient": "<string>",
"recipient_amount": "<string>",
"recipient_currency": "<string>",
"refund_destination": "<string>",
"signature": "<string>"
},
"metadata": {
"chain_id": 123,
"contract_address": "<string>",
"sender": "<string>"
}
},
"contract_address": "<string>",
"contract_addresses": {
"1": "0xabc123",
"137": "0x987654"
}
}
}
Authorizations
Body
application/json
Response
201
application/json
Charge
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://api.commerce.coinbase.com/charges \
--header 'Content-Type: application/json' \
--header 'X-CC-Api-Key: <api-key>' \
--data '{
"buyer_locale": "<string>",
"cancel_url": "<string>",
"checkout_id": "<string>",
"local_price": {
"amount": "<string>",
"currency": "<string>"
},
"metadata": {
"custom_field": "internal_id",
"custom_field_two": "anything"
},
"pricing_type": "fixed_price",
"redirect_url": "<string>"
}'
Copy
Ask AI
{
"brand_color": "<string>",
"brand_logo_url": "<string>",
"charge_kind": "WEB3",
"checkout": {
"id": "<string>"
},
"code": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"hosted_url": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organization_name": "<string>",
"pricing": {
"local": {
"amount": "<string>",
"currency": "<string>"
},
"settlement": {
"amount": "<string>",
"currency": "<string>"
}
},
"pricing_type": "fixed_price",
"redirects": {
"cancel_url": "<string>",
"success_url": "<string>",
"will_redirect_after_success": true
},
"support_email": "jsmith@example.com",
"third_party_provider": "<string>",
"timeline": [
{
"status": "COMPLETED",
"time": "2023-11-07T05:31:56Z"
}
],
"web3_data": {
"failure_events": [
{
"input_token_address": "<string>",
"network_fee_paid": "<string>",
"reason": "<string>",
"sender": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"tx_hsh": "<string>"
}
],
"success_events": [
{
"finalized": true,
"input_token_address": "<string>",
"input_token_amount": "<string>",
"network_fee_paid": "<string>",
"recipient": "<string>",
"sender": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"tx_hsh": "<string>"
}
],
"transfer_intent": {
"call_data": {
"deadline": "<string>",
"fee_amount": "<string>",
"id": "<string>",
"operator": "<string>",
"prefix": "<string>",
"recipient": "<string>",
"recipient_amount": "<string>",
"recipient_currency": "<string>",
"refund_destination": "<string>",
"signature": "<string>"
},
"metadata": {
"chain_id": 123,
"contract_address": "<string>",
"sender": "<string>"
}
},
"contract_address": "<string>",
"contract_addresses": {
"1": "0xabc123",
"137": "0x987654"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.