PPS ORIAN API
Example messages
The following examples represent a selection of ORIAN requests and responses that may be used for guidance. Note that different payment schemes, and indeed different transactions on the same payment scheme, may include different information.
Delegated Authorisation
Approved Mastercard Purchase Authorisation
Request
PUT /v2/transactions/18020114280135473
{
"id": "18020114280135473",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "38395",
"retrieval_reference": "GBH4958676"
}
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
]
}Response
{
"id": "18020114280135473",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "38395",
"retrieval_reference": "GBH4958676"
}
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
]
}Declined Mastercard Purchase Authorisation
Response
{
"id": "18020114280135473",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"txn_result": {
"result": "DECLINED",
"result_detail": "DECLINED_DUE_TO_POTENTIAL_FRAUD"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN"
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "38395",
"retrieval_reference": "GBH4958676"
}
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
]
}Approved Incoming Faster Payment
Request
PUT /v2/transactions/18092516500618589
{
"id": "18092516500618589",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-09-25T16:50:06+0100",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"payee": {
"account": {
"account_no": "51451909629995",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "FP ORIAN PAYEE",
"sort_code": "236972",
"account_no": "01812704"
}
},
"payer": {
"bank_account": {
"name": "Payer Name",
"sort_code": "236972",
"account_no": "01234567"
}
},
"txn_type": {
"code": "PAYMENT_IN",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT",
"verification_results": [],
"cardholder_present": false,
"card_present": false
},
"authorisation": {
"auth_date_time": "2018-09-25T16:50:06Z",
"local_date_time": "2018-09-25T16:50:06",
"txn_amounts": {
"requested_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "RP17061215293729011020170612826236973",
"payment_reference": "REF, FPIDFPL02",
"additional_info": "B BSPAYGALASTREF FPIDFPL01"
}
},
"txn_ledgers": [
{
"txn_id": "18092516500618589",
"txn_type": "RED"
}
]
}Response
{
"id": "18092516500618589",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-09-25T16:50:06+0100",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "51451909629995",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "FP ORIAN PAYEE",
"sort_code": "236972",
"account_no": "01812704"
}
},
"payer": {
"bank_account": {
"name": "Payer Name",
"sort_code": "236972",
"account_no": "01234567"
}
},
"txn_type": {
"code": "PAYMENT_IN",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT",
"verification_results": [],
"cardholder_present": false,
"card_present": false
},
"authorisation": {
"auth_date_time": "2018-09-25T16:50:06Z",
"local_date_time": "2018-09-25T16:50:06",
"txn_amounts": {
"requested_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "RP17061215293729011020170612826236973",
"payment_reference": "REF, FPIDFPL02",
"additional_info": "B BSPAYGALASTREF FPIDFPL01"
}
},
"txn_ledgers": [
{
"txn_id": "18092516500618589",
"txn_type": "RED"
}
]
}Approved Outbound Faster Payment
Request
PUT /v2/transactions/18092414221618230
{
"id": "18092414221618230",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-09-24T14:22:16+0100",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"payee": {
"bank_account": {
"name": "Payee Name",
"sort_code": "236972",
"account_no": "01234567"
}
},
"payer": {
"account": {
"account_no": "89322361519636",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "Payer Name",
"sort_code": "236972",
"account_no": "01812704"
}
},
"txn_type": {
"code": "PAYMENT_OUT",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT",
},
"authorisation": {
"auth_date_time": "2018-09-24T14:22:16Z",
"local_date_time": "2018-09-24T14:22:16",
"txn_amounts": {
"requested_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
},
"txn_ledgers": [
{
"txn_id": "18092414221618230",
"txn_type": "PYO"
}
]
}Response
{
"id": "18092414221618230",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-09-24T14:22:16+0100",
"txn_lifecycle_status": "AUTHORISATION_REQUESTED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"bank_account": {
"name": "Payee Name",
"sort_code": "236972",
"account_no": "01234567"
}
},
"payer": {
"account": {
"account_no": "89322361519636",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 36200,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "Payer Name",
"sort_code": "236972",
"account_no": "01812704"
}
},
"txn_type": {
"code": "PAYMENT_OUT",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT",
},
"authorisation": {
"auth_date_time": "2018-09-24T14:22:16Z",
"local_date_time": "2018-09-24T14:22:16",
"txn_amounts": {
"requested_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
},
"txn_ledgers": [
{
"txn_id": "18092414221618230",
"txn_type": "PYO"
}
]
}ORIAN Notifications
Approved Mastercard Purchase Authorisation
Request
PUT /v2/transactions/18020114280135473
{
"id": "18020114280135473",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "AUTHORISED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 400,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"auth_code": "837465",
"auth_expiry_date_time": "2018-08-12T15:00:00Z",
"txn_reference": {
"scheme_txn_reference": "38395",
"retrieval_reference": "GBH4958676"
}
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
]
}Cancelled Mastercard Purchase Authorisation
Request
PUT /v2/transactions/18020114280135473
{
"id": "18020114280135473",
"version": 3,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "CANCELLED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"auth_code": "837465",
"txn_reference": {
"scheme_txn_reference": "38395",
"retrieval_reference": "GBH4958676"
}
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
],
"completed_date_time": "2018-08-02T16:00:00Z"
}Mastercard Purchase Clearing
Request
PUT /v2/transactions/18020114280135473
{
"id": "18020114280135473",
"version": 3,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 400,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 400,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"authorisation": {
"auth_date_time": "2018-08-02T15:00:00Z",
"local_date_time": "2018-08-02T15:00:00",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"auth_code": "837465",
},
"clearing": {
"clear_date_time": "2018-08-03T14:00:00Z",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
},
"txn_ledgers": [
{
"txn_id": "18020114280135473",
"txn_type": "RED"
}
],
"completed_date_time": "2018-08-03T14:00:00Z"
}Offline Mastercard Refund
Request
PUT /v2/transactions/18020114280135475
{
"id": "18020114280135475",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:00Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 710,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 710,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"payer": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"country": "GBR",
"postcode": "SN1 1GW"
}
},
"txn_type": {
"code": "REFUND",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"clearing": {
"clear_date_time": "2018-08-02T15:00:00Z",
"txn_amounts": {
"requested_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
},
"txn_ledgers": [
{
"txn_id": "18020114280135475",
"txn_type": "REF"
}
],
"completed_date_time": "2018-08-02T15:00:00Z"
}Offline Mastercard Refund Reversal
Request
PUT /v2/transactions/18020114280135476
{
"id": "18020114280135476",
"version": 1,
"scheme_id": "MC",
"product_class_id": "MY_PRODUCT_CLASS",
"created_date_time": "2018-08-02T15:00:10Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "My Merchant",
"id_auth": "123456",
"acquirer_id_auth": "123456",
"terminal_id": "a1b2c3d4",
"category_auth": "5812",
"address": {
"street_address":"station road",
"country": "GBR",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "73648576",
"account_ext_ref": "A5453627",
"balance_code": "MAIN",
"balances": [{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}, {
"type": "CLEARED",
"amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3902076592",
"masked_pan": "123456******9876"
}
},
"txn_type": {
"code": "REFUND_REVERSAL",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP",
"verification_results": [{
"method": "CRYPTOGRAM",
"entity": "ISSUER",
"result": "SUCCESS"
}
],
"cardholder_present": true,
"card_present": true,
"pos_data": {
"terminal_pan_entry_mode": "CHIP",
"terminal_pin_entry_capability": "PIN_ENTRY_CAPABILITY",
"terminal_attendance": "ATTENDED",
"terminal_location": "ON_PREMISE"
}
},
"clearing": {
"clear_date_time": "2018-08-02T15:00:10Z",
"txn_amounts": {
"requested_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 210,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
},
"txn_ledgers": [
{
"txn_id": "18020114280135476",
"txn_type": "REF_REV"
}
],
"completed_date_time": "2018-08-02T15:00:10Z"
}Offline Cleared Redemption
Request
PUT /v2/transactions/20022515423912693
{
"id": "20022515423912693",
"version": 1,
"scheme_id": "MC",
"product_class_id": "TC3_ORIAN_STANDARD",
"created_date_time": "2020-02-25T15:42:39Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": ",",
"id_clear": "123456",
"category_clear": "5011",
"address": {
"street_address":"station road",
"country": "ARE",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "79209234031974",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36100,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 36100,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "5615211355",
"masked_pan": "531160******8818"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "UNKNOWN"
},
"clearing": {
"clear_date_time": "2020-02-25T15:42:39Z",
"txn_amounts": {
"requested_amount": {
"amount": 100,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 100,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 100,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "0"
}
},
"txn_ledgers": [
{
"txn_id": "20022515423912693",
"txn_type": "RED"
}
],
"completed_date_time": "2020-02-25T15:42:39Z"
}Topup auth
Request
PUT /v2/transactions/20022614382938070
{
"id": "20022614382938070",
"version": 1,
"scheme_id": "PCS",
"product_class_id": "TC3_ORIAN_PRC",
"created_date_time": "2020-02-26T14:38:29Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "37422528030305",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 37200,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 37200,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
}
},
"payer": {
"acceptor": {
"name": "acceptorName",
"id_auth": "acceptorId"
}
},
"txn_type": {
"code": "TOPUP",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "UNKNOWN"
},
"authorisation": {
"auth_date_time": "2020-02-26T14:38:29Z",
"local_date_time": "2020-02-26T14:38:29",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"auth_code": "005572"
},
"txn_ledgers": [
{
"txn_id": "20022614382938070",
"txn_type": "TOP"
}
],
"completed_date_time": "2020-02-26T14:38:29Z"
}Refund auth
Request
PUT /v2/transactions/20022615183538388
{
"id": "20022615183538388",
"version": 1,
"scheme_id": "MC",
"product_class_id": "TC3_ORIAN_PRC",
"created_date_time": "2020-02-26T15:18:35Z",
"txn_lifecycle_status": "AUTHORISED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "45235075833954",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 36200,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 36200,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "5034549221",
"masked_pan": "531160******1926"
}
},
"payer": {
"acceptor": {
"name": "C3 MAIN BRANCH",
"id_auth": "123456",
"sub_id_auth": "SID",
"acquirer_id_auth": "234567",
"category_auth": "5011",
"address": {
"street_address":"station road",
"country": "ARE",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"txn_type": {
"code": "REFUND",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "CHIP"
},
"authorisation": {
"auth_date_time": "2020-02-26T15:18:35Z",
"local_date_time": "2020-02-26T15:18:35",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"auth_code": "970880",
"auth_expiry_date_time": "2020-02-27T15:18:35Z",
"txn_reference": {
"scheme_txn_reference": "315529",
"retrieval_reference": "PCZ257186800"
}
},
"txn_ledgers": [
{
"txn_id": "20022615183538388",
"txn_type": "REF"
}
]
}Refund reversal
Request
PUT /v2/transactions/2002270901402186
{
"id": "2002270901402186",
"version": 1,
"scheme_id": "PCS",
"product_class_id": "TC3_ORIAN_PRC",
"created_date_time": "2020-02-27T09:01:40Z",
"txn_lifecycle_status": "AUTHORISED",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "C3 MAIN BRANCH>DUBAI",
"id_auth": "STORE_ID",
"acquirer_id_auth": "78412345678",
"category_auth": "6011",
"address": {
"street_address":"station road",
"country": "ARE",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "42899789389428",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 0,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3249411109",
"masked_pan": "531160******5345"
}
},
"txn_type": {
"code": "REDEMPTION",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "MAGSTRIPE"
},
"authorisation": {
"auth_date_time": "2020-02-27T09:01:40Z",
"local_date_time": "2020-02-27T09:01:39",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"auth_code": "425701",
"auth_expiry_date_time": "2020-02-28T09:01:40Z",
"txn_reference": {
"scheme_txn_reference": "099677",
"retrieval_reference": "PCZ257099677"
}
},
"txn_ledgers": [
{
"txn_id": "2002270901402186",
"txn_type": "RED"
}
]
}Withdrawal auth
Request
PUT /v2/transactions/2002270940203121
{
"id": "2002270940203121",
"version": 1,
"scheme_id": "RAKBANK",
"product_class_id": "TC3_ORIAN_PRC",
"created_date_time": "2020-02-27T09:40:20Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"acceptor": {
"name": "C3 MAIN BRANCH DUBAI",
"id_auth": "000000000900001",
"acquirer_id_auth": "78412345678",
"category_auth": "6011",
"address": {
"street_address":"station road",
"country": "ARE",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"payer": {
"account": {
"account_no": "33929195333692",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 0,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 0,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "3541532365",
"masked_pan": "531160******5676"
}
},
"txn_type": {
"code": "WITHDRAWAL",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "MANUAL"
},
"authorisation": {
"auth_date_time": "2020-02-27T09:40:20Z",
"local_date_time": "2020-02-27T09:40:20",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"auth_code": "379434",
"txn_reference": {
"scheme_txn_reference": "420480",
"retrieval_reference": "PCZ257420480"
}
},
"txn_ledgers": [
{
"txn_id": "2002270940203121",
"txn_type": "WTH"
}
],
"completed_date_time": "2020-02-27T09:40:20Z"
}Withdrawal Reversal
Request
PUT /v2/transactions/2002270940133099
{
"id": "2002270940133099",
"version": 1,
"scheme_id": "RAKBANK",
"product_class_id": "TC3_ORIAN_STANDARD",
"created_date_time": "2020-02-27T09:40:13Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "46174001536815",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
}
]
},
"card": {
"serial_no": "4724195531",
"masked_pan": "531160******0479"
}
},
"payer": {
"acceptor": {
"name": "C3 MAIN BRANCH DUBAI",
"id_auth": "000000000900001",
"acquirer_id_auth": "78412345678",
"address": {
"street_address":"station road",
"country": "ARE",
"postcode": "SN1 1GW",
"state":"wilts",
"city": "swindon"
}
}
},
"txn_type": {
"code": "WITHDRAWAL_REVERSAL",
"direction": "CREDIT",
"reversal": true,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "MANUAL"
},
"authorisation": {
"auth_date_time": "2020-02-27T09:40:13Z",
"local_date_time": "2020-02-27T09:40:13",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "AED",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "413065",
"retrieval_reference": "PCZ257413065"
}
},
"txn_ledgers": [
{
"txn_id": "2002270940133099",
"txn_type": "WTH_REV"
}
],
"original_txn_id": "2002270940113097",
"completed_date_time": "2020-02-27T09:40:13Z",
"reason_code": "Rev=null"
}Faster payment in
Request
PUT /v2/transactions/20022809081427060
{
"id": "20022809081427060",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "TC3_ORIAN_UK_BANKING",
"created_date_time": "2020-02-28T09:08:14Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "18996526818557",
"account_ext_ref": "5062223341900",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 1000,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 1000,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "DefaultAccountName",
"sort_code": "236972",
"account_no": "18996526"
}
},
"payer": {
"bank_account": {
"name": "Any UK BankAccount",
"sort_code": "951571",
"account_no": "01209233"
}
},
"txn_type": {
"code": "PAYMENT_IN",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT"
},
"authorisation": {
"auth_date_time": "2020-02-28T09:08:14Z",
"local_date_time": "2020-02-28T09:08:14",
"txn_amounts": {
"requested_amount": {
"amount": 1000,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1000,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1000,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"auth_code": "064097",
"txn_reference": {}
},
"txn_ledgers": [
{
"txn_id": "20022809081427060",
"txn_type": "PYI"
}
],
"completed_date_time": "2020-02-28T09:08:14Z"
}Faster payment out
Request
PUT /v2/transactions/20022811044127044
{
"id": "20022811044127044",
"version": 1,
"scheme_id": "BANKING_FP_BARC",
"product_class_id": "TC3_ORIAN_UK_BANKING",
"created_date_time": "2020-02-28T11:04:41Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"account": {
"account_no": "14851454827233",
"account_ext_ref": "2570032169653",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 37201,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 37201,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "FP ORIAN PAYEE",
"sort_code": "236972",
"account_no": "14851454"
}
},
"payer": {
"bank_account": {
"name": "PAYER + FPIDFPL01",
"sort_code": "236972",
"account_no": "01234567"
}
},
"txn_type": {
"code": "PAYMENT_IN",
"direction": "CREDIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "FASTER_PAYMENT"
},
"authorisation": {
"auth_date_time": "2020-02-28T11:04:41Z",
"local_date_time": "2020-02-28T11:04:41",
"txn_amounts": {
"requested_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 1001,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "RP17061215293729011020170612826236973",
"payment_reference": "REF, FPIDFPL02",
"additional_info": "B BSPAYGALASTREF FPIDFPL01"
}
},
"txn_ledgers": [
{
"txn_id": "20022809081427044",
"txn_type": "PYI"
}
],
"completed_date_time": "2020-02-28T11:04:41Z"
}Direct debit
Request
PUT /v2/transactions/20022809552627043
{
"id": "20022809552627043",
"version": 1,
"scheme_id": "BANKING_BACS_BARC",
"product_class_id": "TC3_ORIAN_UK_BANKING",
"created_date_time": "2020-02-28T09:55:26Z",
"txn_lifecycle_status": "COMPLETE",
"txn_result": {
"result": "APPROVED",
"result_detail": "SUCCESSFUL"
},
"reason_text":"txnResultContent",
"reason_code":"400",
"payee": {
"bank_account": {
"name": "ORIGINATORS _ NAME",
"sort_code": "500001",
"account_no": "50000001"
}
},
"payer": {
"account": {
"account_no": "45445932010822",
"balance_code": "MAIN",
"balances": [
{
"type": "AVAILABLE_TO_SPEND",
"amount": {
"amount": 35700,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
{
"type": "CLEARED",
"amount": {
"amount": 35700,
"currency": {
"code": "GBP",
"exponent": 2
}
}
}
]
},
"bank_account": {
"name": "DESTINATION _ NAME",
"sort_code": "236972",
"account_no": "45445932"
}
},
"txn_type": {
"code": "PAYMENT_OUT",
"direction": "DEBIT",
"reversal": false,
"financial": true,
"activation": false
},
"acceptance": {
"acceptance_method": "DIRECT_DEBIT"
},
"authorisation": {
"auth_date_time": "2020-02-28T09:55:26Z",
"local_date_time": "2020-02-28T09:55:26",
"txn_amounts": {
"requested_amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
},
"cardholder_final_amount": {
"amount": 500,
"currency": {
"code": "GBP",
"exponent": 2
}
}
},
"txn_reference": {
"scheme_txn_reference": "05000001",
"payment_reference": "QUOTED_REFERENCE_#"
}
},
"txn_ledgers": [
{
"txn_id": "20022809552627043",
"txn_type": "PYO"
}
],
"completed_date_time": "2020-02-28T09:55:26Z"
}SEPA Direct debit mandate
Request
PUT /v2/direct-debit-mandates/2ce94272-ebc7-459a-a932-7cde4e09e9c1
{
"id": "2ce94272-ebc7-459a-a932-7cde4e09e9c1",
"scheme": "SEPA",
"originator_id": "UaXoXj9ksVZhqiIAPY386u48gfq3iHULxgX",
"reference": "OVQtkpKeqZ1zTxZCyJoGWfJf766uXYuiKeg",
"status": "PENDING",
"amount": {
"amount": 10000,
"currency": {
"code": "EUR",
"exponent": 2
}
},
"payer": {
"bank_account": {
"name": "PAYERNAME",
"iban": "FR7616977000020000000024818",
"bic": "PRTCGB21XXX",
"address": {
"line1":"1 Silver St",
"line2":"Swindon",
"country":"UK"
}
},
"account": {
"account_no": "21120917602508"
}
},
"payee": {
"bank_account": {
"name": "PAYEENAME",
"iban": "LU978881234567891016",
"bic": "MAGYLUL1XXX",
}
},
"apply_date": "2020-02-28",
"requested_date": "2020-02-28",
"signature_date": "2020-02-28",
"last_collection_date_time": "2020-06-26T18:25:43Z",
"mandate_type": "B2B",
"version": 0
}BACS Direct debit mandate
Request
PUT /v2/direct-debit-mandates/2ce94272-ebc7-459a-a932-7cde4e09e9c1
{
"id": "2ce94272-ebc7-459a-a932-7cde4e09e9c1",
"scheme": "BACS",
"originator_id": "UaXoXj9ksVZhqiIAPY386u48gfq3iHULxgX",
"reference": "OVQtkpKeqZ1zTxZCyJoGWfJf766uXYuiKeg",
"status": "ACTIVE",
"amount": {
"amount": 10000,
"currency": {
"code": "EUR",
"exponent": 2
}
},
"payer": {
"bank_account": {
"name": "PAYERNAME",
"iban": "FR7616977000020000000024818",
"bic": "PRTCGB21XXX",
"address": {
"line1":"1 Silver St",
"line2":"Swindon",
"country":"UK"
}
},
"account": {
"account_no": "21120917602508"
}
},
"payee": {
"bank_account": {
"name": "PAYEENAME",
"iban": "LU978881234567891016",
"bic": "MAGYLUL1XXX",
}
},
"apply_date": "2020-02-28",
"requested_date": "2020-02-28",
"signature_date": "2020-02-28",
"last_collection_date_time": "2020-06-26T18:25:43Z",
"mandate_type": "B2B",
"version": 0
}Cancelled BACS Direct debit mandate
Request
PUT /v2/direct-debit-mandates/2ce94272-ebc7-459a-a932-7cde4e09e9c1
{
"id": "2ce94272-ebc7-459a-a932-7cde4e09e9c1",
"scheme": "BACS",
"originator_id": "UaXoXj9ksVZhqiIAPY386u48gfq3iHULxgX",
"reference": "OVQtkpKeqZ1zTxZCyJoGWfJf766uXYuiKeg",
"status": "CANCELLED",
"amount": {
"amount": 10000,
"currency": {
"code": "EUR",
"exponent": 2
}
},
"payer": {
"bank_account": {
"name": "PAYERNAME",
"iban": "FR7616977000020000000024818",
"bic": "PRTCGB21XXX",
"address": {
"line1":"1 Silver St",
"line2":"Swindon",
"country":"UK"
}
},
"account": {
"account_no": "21120917602508"
}
},
"payee": {
"bank_account": {
"name": "PAYEENAME",
"iban": "LU978881234567891016",
"bic": "MAGYLUL1XXX",
}
},
"apply_date": "2020-02-28",
"requested_date": "2020-02-28",
"signature_date": "2020-02-28",
"last_collection_date_time": "2020-06-26T18:25:43Z",
"mandate_type": "B2B",
"reason_code": "INSTRUCTION_CANCELLED_BY_PAYER",
"reason_text": "Direct debit mandate cancelled.",
"cancelled_date": "2020-06-26",
"version": 0
}