Payment Intent Api
POST/v6/intent/create
This endpoint initiates the creation of a payment intent, which is a precursor to processing a payment. A payment intent captures the details of a prospective payment transaction, including the payment amount, currency, and associated billing and shipping information.
200 OK PaymentIntentReference
Request
PaymentIntentRequestModel
{
"adjustments":[
{
"accumulate":"",
"adjustment":"",
"amount":19995,
"conditions":[
{
"anchor":"",
"discount_code":"",
"duration":7,
"end_date":"2024-08-31",
"start_date":"2024-08-01"
}
],
"description":"10% discount for loyalty program members",
"percentage":"17.5"
}
],
"amount":19995,
"avs_postcode_policy":"",
"bill_to":{
"address1":"79 Parliament St",
"address2":"Westminster",
"address3":"",
"area":"London",
"company":"Acme Ltd",
"country":"GB",
"email":"card.holder@citypay.com",
"firstname":"John",
"lastname":"Smith",
"mobile_no":"+447790123456",
"postcode":"L1 789",
"telephone_no":"+442030123456",
"title":"Mr"
},
"csc_policy":"",
"currency":"GBP",
"duplicate_policy":"",
"external-ref":"ABC123",
"external-ref-source":"xero",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"match_avsa":"",
"merchantid":11223344,
"pre_auth":"",
"ship_to":{
"address1":"79 Parliament St",
"address2":"Westminster",
"address3":"",
"area":"London",
"company":"Acme Ltd",
"country":"GB",
"email":"card.holder@citypay.com",
"firstname":"John",
"lastname":"Smith",
"mobile_no":"+447790123456",
"postcode":"L1 789",
"telephone_no":"+442030123456",
"title":"Mr"
},
"tag":[],
"trans_info":"",
"trans_type":""
}
Response
PaymentIntentReference
{
"payment_intent_id":"p13t1111222233334444"
}
POST/v6/intent/retrieve
Request
FindPaymentIntentRequest
{
"external-ref":"ABC123",
"external-ref-source":"xero",
"merchantid":11223344,
"payment_intent_id":"p13t1111222233334444"
}
Response
PaymentIntentResponseModel
{
"adjustments":[
{
"accumulate":"",
"adjustment":"",
"amount":19995,
"conditions":[
{
"anchor":"",
"discount_code":"",
"duration":7,
"end_date":"2024-08-31",
"start_date":"2024-08-01"
}
],
"description":"10% discount for loyalty program members",
"percentage":"17.5"
}
],
"amount":19995,
"created":"2025-06-06T13:53:57Z",
"currency":"GBP",
"due":"2025-06-06",
"expires":"2025-06-06",
"external-ref":"ABC123",
"external-ref-source":"xero",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"intent_status":"open",
"merchantid":11223344,
"payment-type":"",
"payment_intent_id":"p13t1111222233334444",
"transactions":[
{
"address":"Mielles House, St Helier, Jersey",
"amount":"20.00",
"amount_value":3600,
"atrn":"",
"authcode":"001245A",
"authen_result":"",
"batchno":"",
"bin_commercial":false,
"bin_consumer":false,
"bin_corporate":true,
"bin_credit":true,
"bin_debit":false,
"cardholder_agreement":"",
"currency":"GBP",
"datetime":"2025-01-02T18:32:28Z",
"eci":"05",
"email":"card.holder@citypay.com",
"env":"",
"identifier":"95b857a1-5955-4b86-963c-5a6dbfc4fb95",
"initiation":"",
"instrument":"Card",
"maskedpan":"4***********0002",
"merchantid":11223344,
"meta":{},
"name_on_card":"MR NE BODY",
"postcode":"L6 12W",
"result":"",
"result_id":"",
"scheme":"Visa",
"scheme_logo":"https://cdn.citypay.com/img/cs/visa-logo.svg",
"trans_status":"",
"trans_type":"",
"transno":78416,
"type":"",
"utc":"1746299303000"
}
]
}