curl 'https://api.yativo.com/api/v1/card-checkout/customers/4f0c1e1a-8d2b-4c7e-9b1a-3e5f6a7b8c9d' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
{
"status": "success",
"status_code": 200,
"message": "Request successful",
"data": {
"customer_id": "4f0c1e1a-8d2b-4c7e-9b1a-3e5f6a7b8c9d",
"customer_type": "individual",
"endorsement_status": "not_started",
"verification_status": "pending",
"can_accept_payments": true,
"onboarding_url": "<string>",
"onboarding_url_expires_at": "2023-11-07T05:31:56Z",
"balance": {
"currency": "USD",
"available": "96.20",
"pending": "0.00",
"reserved": "0.00",
"on_hold": "0.00",
"total": "96.20",
"next_available_at": "2023-11-07T05:31:56Z"
},
"message": "<string>",
"awaiting_business_access": true
}
}{
"status": "failed",
"status_code": 403,
"message": "<string>",
"data": {
"error": "Card checkout is not enabled for your account. Contact support to request access.",
"code": "card_checkout_not_enabled"
},
"error": {
"code": "invalid_argument",
"message": "<string>",
"request_id": "req_5f2c9a1e7b3d4c8a6e0f1b2d"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 403,
"message": "<string>",
"data": {
"error": "Card checkout is not enabled for your account. Contact support to request access.",
"code": "card_checkout_not_enabled"
},
"error": {
"code": "invalid_argument",
"message": "<string>",
"request_id": "req_5f2c9a1e7b3d4c8a6e0f1b2d"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Selling customers
Get selling customer
Read a customer’s card_checkout endorsement
GET
/
card-checkout
/
customers
/
{customer_id}
curl 'https://api.yativo.com/api/v1/card-checkout/customers/4f0c1e1a-8d2b-4c7e-9b1a-3e5f6a7b8c9d' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
{
"status": "success",
"status_code": 200,
"message": "Request successful",
"data": {
"customer_id": "4f0c1e1a-8d2b-4c7e-9b1a-3e5f6a7b8c9d",
"customer_type": "individual",
"endorsement_status": "not_started",
"verification_status": "pending",
"can_accept_payments": true,
"onboarding_url": "<string>",
"onboarding_url_expires_at": "2023-11-07T05:31:56Z",
"balance": {
"currency": "USD",
"available": "96.20",
"pending": "0.00",
"reserved": "0.00",
"on_hold": "0.00",
"total": "96.20",
"next_available_at": "2023-11-07T05:31:56Z"
},
"message": "<string>",
"awaiting_business_access": true
}
}{
"status": "failed",
"status_code": 403,
"message": "<string>",
"data": {
"error": "Card checkout is not enabled for your account. Contact support to request access.",
"code": "card_checkout_not_enabled"
},
"error": {
"code": "invalid_argument",
"message": "<string>",
"request_id": "req_5f2c9a1e7b3d4c8a6e0f1b2d"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 403,
"message": "<string>",
"data": {
"error": "Card checkout is not enabled for your account. Contact support to request access.",
"code": "card_checkout_not_enabled"
},
"error": {
"code": "invalid_argument",
"message": "<string>",
"request_id": "req_5f2c9a1e7b3d4c8a6e0f1b2d"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Same shape as the submit-endorsement response. When the endorsement has not been submitted,
See Follow the endorsement.
endorsement_status is not_started. When it is approved, the response includes balance (available, pending, reserved). Only available can be withdrawn.
GET https://api.yativo.com/api/v1/card-checkout/customers/{customer_id}
curl 'https://api.yativo.com/api/v1/card-checkout/customers/4f0c1e1a-8d2b-4c7e-9b1a-3e5f6a7b8c9d' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'X-Api-Secret: YOUR_API_SECRET'
Authorizations
Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.
Your API secret (yativo_sk_...), shown once when the key is created.
Path Parameters
Your customer.