create_payment_link
Create a payment link in JOD for Jordan via Tap Payments. Buyer pays with cards, Apple Pay — whatever is enabled on the Tap account. Returns a hosted checkout URL the buyer opens to pay — payment completes automatically, no confirm step. Bring your own credentials via HTTP header (x-tap-secret-key; free test credentials from businesses.tap.company never move real money). Money always flows buyer→Tap Payments→merchant; this service never touches funds.
Parameters5
| amount_jod | number | required | Amount in JOD (decimals allowed), e.g. 10. Minimum 1. |
| description | string | required | What this payment is for (shown to the buyer, ≤200 chars) |
| customer_email | string | required | Buyer email (required by Tap Payments; the receipt goes there). |
| reference_id | string | optional | Your unique order reference (≤40 chars). Auto-generated if omitted. |
| success_url | string | optional | Optional https URL to send the buyer to after payment. |
Raw schema
{
"type": "object",
"properties": {
"amount_jod": {
"type": "number",
"minimum": 1,
"maximum": 1000000,
"description": "Amount in JOD (decimals allowed), e.g. 10. Minimum 1."
},
"description": {
"type": "string",
"description": "What this payment is for (shown to the buyer, ≤200 chars)"
},
"customer_email": {
"type": "string",
"description": "Buyer email (required by Tap Payments; the receipt goes there)."
},
"reference_id": {
"type": "string",
"description": "Your unique order reference (≤40 chars). Auto-generated if omitted."
},
"success_url": {
"type": "string",
"description": "Optional https URL to send the buyer to after payment."
}
},
"required": [
"amount_jod",
"description",
"customer_email"
]
}