REST API Reference

External Host Namespace

The external host namespace contains the resource to manage external host with the following Methods Method Endpoint Scope Description.


Operation Method Endpoint Scope Sample Description
Account Change Notification Post receiving webhook url ExternalHost Sample Account Change Notification
Interchange Authorization Notification Post receiving webhook url ExternalHost Sample Interchange Authorization Notification
Account Interchange Financial Post Notification Post receiving webhook url ExternalHost Sample Interchange Financial Post Notification
Organization Change Notification Post receiving webhook url ExternalHost Sample Organization Change Notification
Payment Gateway Notification Post receiving webhook url ExternalHost Sample Payment Gateway Notification
Service Fee Notification Post receiving webhook url ExternalHost Sample Service Fee Notification
System Financial Notification Post receiving webhook url ExternalHost Sample System Financial Notification
Ticket Notification Post receiving webhook url ExternalHost Sample Ticket Notification
User Change Notification Post receiving webhook url ExternalHost Sample User Change Notification

Data Object

Field Name Field Type Regular Expression Sample Field Status
POST PUT GET DELETE
external_host_data
info

Security Type: None

Object None R O NA NA
host_message

Security Type: None

Object None R O NA NA
webhook

Security Type: None

Object None R O NA NA
network

Security Type: None

Object None R O NA NA
info
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
program_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 R R NA NA
user_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 O O NA NA
entity

Security Type: None

Integer ^(-1|[0-9]{1,2})$ 10,3,-1 C NA NA NA
entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 C NA NA NA
entity_data

Security Type: None

Integer ^[0-9]{1,3}$ 900 NA O NA NA
operation_type

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 O O O O
original_source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
server_date

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
mode

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
host_message_type

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
transaction_indicator

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
status

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
delivery_status

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
stand_in

Security Type: None

Boolean ^[0-1]{1,1}$ 1, 0 NA NA NA NA
sending_count

Security Type: None

Integer ^[0-9]{1,1}$ 0-9 O O O O
api_key

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
api_key

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
includes_sensitive_data

Security Type: None

Boolean ^[0-1]{1,1}$ 1, 0 NA NA NA NA
info
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
cluster_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
program_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
parent_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
sub_entity

Security Type: None

Object None NA O NA NA
by_entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
by_entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
assigned_to_entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
assigned_to_entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity_data

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
status

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
description_code

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
category

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
type

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
scope

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
priority

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
service_provider

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
service_method

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
server_date

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
client_dates

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
update_date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
source_time_zone

Security Type: None

String ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ UTC -06:00, UTC +02:30 NA NA NA NA
original_source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
info
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
cluster_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
info
server_date

Security Type: None

String ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ UTC -06:00, UTC +02:30 NA NA NA NA
date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
client_dates

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
original_source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
host_message
iso_data

Security Type: None

Object None R O NA NA
user_data

Security Type: None

Object None R O NA NA
account_data

Security Type: None

Object None R O NA NA
transaction_data

Security Type: None

Object None R O NA NA
order_data

Security Type: None

Object None R O NA NA
ticket_data

Security Type: None

Object None R O NA NA
fee_definition

Security Type: None

Object None R O NA NA
otp_authentication_data

Security Type: None

Object None R O NA NA
conversion

Security Type: None

Object None R O NA NA
blocking_details

Security Type: None

Object None R O NA NA
organization_data

Security Type: None

Object None R O NA NA
iso_message
reply_to

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
d

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
mti

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso033

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso034

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso035

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso036

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso037

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso038

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso039

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso040

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso041

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso042

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso043

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso044

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso045

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso046

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso047

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso049

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso050

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso051

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso052

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso053

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso054

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso055

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso056

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso057

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso058

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso059

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso060

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso061

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso062

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso063

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso064

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso065

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso066

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso067

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso068

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso069

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso070

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso071

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso073

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso074

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso075

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso076

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso077

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso078

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso079

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso080

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso081

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso082

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso083

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso084

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso085

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso086

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso088

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso089

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso090

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso091

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso092

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso093

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso094

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso095

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso096

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso097

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso098

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso099

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso100

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso101

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso102

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso103

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso104

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso105

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso107

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso108

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso109

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso110

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso111

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso112

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso113

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso114

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso115

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso116

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso117

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso118

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso119

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso120

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso121

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso122

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso123

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso124

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso125

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso126

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso127

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso128

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_13

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_17

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_20

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_26

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_30

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_33

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_38

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_42

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_43

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_61

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_63

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_71

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_72

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_77

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_80

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_82

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_83

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_84

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_87

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_89

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_92

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_98

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
iso048_98

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
ticket_data
info

Security Type: None

Object None R O NA NA
content

Security Type: None

Object None R O NA NA
history

Security Type: None

Object None R O NA NA
ExternalHostInfo

Security Type: None

Object None R O NA NA
ticket_json

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
info
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
cluster_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
program_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
parent_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
sub_entity

Security Type: None

Object None NA O NA NA
by_entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
by_entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
assigned_to_entity

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
assigned_to_entity_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
entity_data

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
status

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
description_code

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
category

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
type

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
scope

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
priority

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
service_provider

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
service_method

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
server_date

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
client_dates

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
update_date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
source_time_zone

Security Type: None

String ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ UTC -06:00, UTC +02:30 NA NA NA NA
original_source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
content
subject

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
content

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
ExternalHostInfo
ExternalHostMessageType

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
ExternalHostMode

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
MessageDescription

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
MessageDescriptionCode

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
OldAccountStatus

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
OTPAuthenticationData
info

Security Type: None

Object None R O NA NA
ExternalHostInfo

Security Type: None

Object None R O NA NA
info
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
cluster_id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
info
server_date

Security Type: None

String ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ UTC -06:00, UTC +02:30 NA NA NA NA
date_utc

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
client_dates

Security Type: None

Date ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) NA NA NA NA
original_source_id

Security Type: None

String ^[a-zA-Z0-9]{1,100} 2Feb2015000001 NA NA NA NA
blocking_details
id

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
name

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
description

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
type

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
simplified_type

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA
webhook
headers

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
content_type

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
url

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
method

Security Type: None

String ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ Abc00, fʁɑ̃s123 NA NA NA NA
network
information_code

Security Type: None

Integer ^[0-9]{1,10}$ 5000000 NA R NA NA

Account Change Notification

Account Change Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2866169,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  10,
        
			"entity_id":  123456,
        
			"entity_data":  5,
        
			"operation_type":  3,
        
			"source_id":  "to5z6AtY52JwxHY8G9NF1676363778",
        
			"original_source_id":  "to5z6AtY52JwxHY8G9NF1676363778",
        
			"server_date":  "2023-02-14T08:36:19",
        
			"date_utc":  "2023-02-14T08:36:19",
        
			"mode":  1,
        
			"host_message_type":  5,
        
			"host_message_desc":  "Account ID: 123456 - Account Status updated successfully, from (Closed) to (Active) (User ID: 123456)",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  123456,
                
			"supplied_id":  321654,
                
			"program_id":  1234,
                
			"bin_id":  1111,
                
			"user_id":  123456,
                
			"name":  null,
                
			"nick_name":  null,
                
			"type":  null,
                
			"number":  "7wcvzEHPht/G31ZgSrZpmlCxnLAJ6WzDXbttsL7UUqI=",
                
			"card_image":  null,
                
			"currency":  null,
                
			"status":  "1",
                
			"usage_status":  null,
                
			"balance":  "0.00",
                
			"available_balance":  "0.00",
                
			"activation_date_time":  null,
                
			"replace_account":  null,
                
			"original_source_id":  null,
                
			"server_date":  null,
                
			"date_utc":  null,
                
			"client_date":  null,
                
			"source_time_zone":  null,
                
			"security":  null,
                
			"is_multi_currency":  null
			
            },
            
			"limits":  null,
            
			"archive":  null,
            
			"custom_field":  null,
            
			"geo_coordinates":  null,
            
			"options":  null,
            
			"bank_account":  null,
            
			"history":  null,
            
			"fulfilment":  null,
            
			"access_rule":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  "UTC +00:00",
            
			"time_zone_name":  "Africa/Ouagadougou",
            
			"response_time":  0
			
        },
        
			"transaction_data":  null,
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"a27sKG0Vy6dTY3hv0kw==\",\"Content-Type\":\"application/json\",\"source_id\":\"fe4273b7-346d-41e3-8790-0d840f9c4529\",\"time_zone\":\"UTC +00:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/account/123456",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Interchange Authorization Notification

Interchange Authorization Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2866231,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  11,
        
			"entity_id":  0,
        
			"entity_data":  -1,
        
			"operation_type":  1,
        
			"source_id":  "MC.123456.0214091401.470605",
        
			"original_source_id":  "MC.123456.0214091401.470605",
        
			"server_date":  "2023-02-14T09:14:43",
        
			"date_utc":  "2023-02-14T09:14:43",
        
			"mode":  1,
        
			"host_message_type":  1,
        
			"host_message_desc":  "Interchange Purchase - on 02-14 - LIDL     3212          PARIS         FRA",
        
			"transaction_indicator":  1,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  {
            
			"h.ReplyTo":  null,
            
			"d":  null,
            
			"000":  "0100",
            
			"002":  null,
            
			"003":  "000000",
            
			"004":  "000000000344",
            
			"005":  null,
            
			"006":  "000000000344",
            
			"007":  "0214091401",
            
			"008":  null,
            
			"009":  null,
            
			"010":  "61000000",
            
			"011":  "470605",
            
			"012":  "101400",
            
			"013":  "0214",
            
			"014":  null,
            
			"015":  "0214",
            
			"016":  "0213",
            
			"017":  null,
            
			"018":  "5310",
            
			"019":  null,
            
			"020":  null,
            
			"021":  null,
            
			"022":  "072",
            
			"023":  "000",
            
			"024":  null,
            
			"025":  null,
            
			"026":  null,
            
			"027":  null,
            
			"028":  null,
            
			"029":  null,
            
			"030":  null,
            
			"031":  null,
            
			"032":  "012916",
            
			"033":  "200653",
            
			"034":  null,
            
			"035":  null,
            
			"036":  null,
            
			"037":  "021400470605",
            
			"038":  "500242",
            
			"039":  "00",
            
			"040":  null,
            
			"041":  "00000001",
            
			"042":  "05999296       ",
            
			"043":  "LIDL     3212          PARIS         FRA",
            
			"044":  null,
            
			"045":  null,
            
			"046":  null,
            
			"047":  null,
            
			"048":  null,
            
			"049":  "978",
            
			"050":  null,
            
			"051":  "978",
            
			"052":  null,
            
			"053":  null,
            
			"054":  "0001978C000000003207",
            
			"055":  null,
            
			"056":  null,
            
			"057":  null,
            
			"058":  null,
            
			"059":  null,
            
			"060":  null,
            
			"061":  "000000000030025075013",
            
			"062":  null,
            
			"063":  "MRG6TCT1M",
            
			"064":  null,
            
			"065":  null,
            
			"066":  null,
            
			"067":  null,
            
			"068":  null,
            
			"069":  null,
            
			"070":  null,
            
			"071":  null,
            
			"072":  null,
            
			"073":  null,
            
			"074":  null,
            
			"075":  null,
            
			"076":  null,
            
			"077":  null,
            
			"078":  null,
            
			"079":  null,
            
			"080":  null,
            
			"081":  null,
            
			"082":  null,
            
			"083":  null,
            
			"084":  null,
            
			"085":  null,
            
			"086":  null,
            
			"087":  null,
            
			"088":  null,
            
			"089":  null,
            
			"090":  null,
            
			"091":  null,
            
			"092":  null,
            
			"093":  null,
            
			"094":  null,
            
			"095":  null,
            
			"096":  null,
            
			"097":  null,
            
			"098":  null,
            
			"099":  null,
            
			"100":  null,
            
			"101":  null,
            
			"102":  null,
            
			"103":  null,
            
			"104":  null,
            
			"105":  null,
            
			"106":  null,
            
			"107":  null,
            
			"108":  null,
            
			"109":  null,
            
			"110":  null,
            
			"111":  null,
            
			"112":  null,
            
			"113":  null,
            
			"114":  null,
            
			"115":  null,
            
			"116":  null,
            
			"117":  null,
            
			"118":  null,
            
			"119":  null,
            
			"120":  null,
            
			"121":  null,
            
			"122":  null,
            
			"123":  null,
            
			"124":  null,
            
			"125":  null,
            
			"126":  null,
            
			"127":  null,
            
			"128":  null,
            
			"048.13":  null,
            
			"048.17":  null,
            
			"048.20":  null,
            
			"048.26":  null,
            
			"048.30":  null,
            
			"048.33":  null,
            
			"048.38":  null,
            
			"048.42":  null,
            
			"048.43":  null,
            
			"048.61":  null,
            
			"048.63":  null,
            
			"048.71":  null,
            
			"048.72":  null,
            
			"048.77":  null,
            
			"048.80":  null,
            
			"048.82":  null,
            
			"048.83":  null,
            
			"048.84":  null,
            
			"048.87":  null,
            
			"048.89":  null,
            
			"048.92":  null,
            
			"048.98":  null,
            
			"048.99":  null
			
        },
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  0,
                
			"parent_id":  0,
                
			"account_id":  123456,
                
			"user_id":  123456,
                
			"pos_id":  0,
                
			"status":  1,
                
			"type":  48,
                
			"classification":  "Withdrawal",
                
			"operation":  "Debit",
                
			"amount":  "3.44",
                
			"currency":  "EUR",
                
			"balance":  "106.29",
                
			"available_balance":  "28.63",
                
			"notes":  "Purchase for 3.44 (EUR) - on 02-14 - LIDL     3212          PARIS         FRA",
                
			"original_source_id":  "MC.123456.0214091401.470605",
                
			"server_date":  "2023-02-14T09:14:32",
                
			"date_utc":  "2023-02-14T09:14:32",
                
			"auth_date_utc":  "2023-02-14T09:14:33",
                
			"post_date_utc":  "2023-02-14T09:14:33",
                
			"client_date":  "2023-02-14T09:14:32",
                
			"auth_client_date":  "2023-02-14T09:14:33",
                
			"post_client_date":  "2023-02-14T09:14:33",
                
			"source_time_zone":  "UTC +00:00",
                
			"service_provider":  0
			
            },
            
			"account":  {
                
			"result":  null,
                
			"info":  {
                    
			"id":  123456,
                    
			"supplied_id":  321654,
                    
			"program_id":  1234,
                    
			"bin_id":  "1111",
                    
			"user_id":  123456,
                    
			"name":  "Icare MasterCard",
                    
			"nick_name":  null,
                    
			"type":  "0",
                    
			"number":  "Iva29giGxBOlImzO0ti9yI1Y1C0wyMh8jhklrb3bUZ4=",
                    
			"card_image":  null,
                    
			"currency":  "EUR",
                    
			"status":  "1",
                    
			"usage_status":  "1",
                    
			"balance":  "106.29",
                    
			"available_balance":  "28.63",
                    
			"activation_date_time":  "2022-08-16",
                    
			"replace_account":  null,
                    
			"original_source_id":  "t7vsTY9AI6ZROn7SOywb1635501482",
                    
			"server_date":  "2021-10-29T10:58:03",
                    
			"date_utc":  "2021-10-29T09:58:03",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +00:00",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"limits":  null,
                
			"archive":  null,
                
			"custom_field":  null,
                
			"geo_coordinates":  null,
                
			"options":  null,
                
			"bank_account":  null,
                
			"history":  null,
                
			"fulfilment":  null,
                
			"access_rule":  null,
                
			"notes":  null,
                
			"last_activity":  null,
                
			"authentication":  null,
                
			"validate":  null,
                
			"function_code":  0,
                
			"time_zone":  null,
                
			"time_zone_name":  null,
                
			"response_time":  0
			
            },
            
			"fee":  null,
            
			"tax":  null,
            
			"conversion":  {
                
			"from_currency":  "EUR",
                
			"to_currency":  "EUR",
                
			"original_amount":  "3.44",
                
			"first_converted_amount":  "0.00",
                
			"converted_amount":  "3.44",
                
			"first_converted_amount_without_margin":  "0.00",
                
			"converted_amount_without_margin":  "0.00",
                
			"conversion_type":  0,
                
			"ws_setup_id":  0,
                
			"currency_rate":  "1.0000",
                
			"second_currency_rate":  "0.0000",
                
			"margin_percent":  0.0,
                
			"second_margin_percent":  0.0,
                
			"margin_percent_from_base":  0.0
			
            },
            
			"exchange":  null,
            
			"transfer":  null,
            
			"credit_card":  null,
            
			"bank_account":  null,
            
			"crypto_wallet":  null,
            
			"payment_info":  null,
            
			"payment_gateway":  null,
            
			"custom_field":  {
                
			"iso_data":  {
                    
			"Message":  {
                        
			"000":  "0100",
                        
			"003":  "000000",
                        
			"007":  "0214091401",
                        
			"010":  "61000000",
                        
			"011":  "470605",
                        
			"012":  "101400",
                        
			"013":  "0214",
                        
			"015":  "0214",
                        
			"016":  "0213",
                        
			"018":  "5310",
                        
			"022":  "072",
                        
			"023":  "000",
                        
			"032":  "012916",
                        
			"033":  "200653",
                        
			"037":  "021400470605",
                        
			"039":  "00",
                        
			"041":  "00000001",
                        
			"042":  "05999296       ",
                        
			"043":  "LIDL     3212          PARIS         FRA",
                        
			"049":  "978",
                        
			"051":  "978",
                        
			"061":  "000000000030025075013",
                        
			"063":  "MRG6TCT1M"
			
                    }
			
                }
			
            },
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"a27sKG0Vy6dTY3hv0kw==\",\"Content-Type\":\"application/json\",\"source_id\":\"fe8409e1-5183-481a-ad31-000bea76f5a3\",\"time_zone\":\"UTC +01:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/transaction/inquiry?original_source_id=MC.123456.0214091401.470605&user_id=123456&status=1",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Interchange Financial Post Notification

Interchange Financial Post Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2865608,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  11,
        
			"entity_id":  2608426,
        
			"entity_data":  -1,
        
			"operation_type":  3,
        
			"source_id":  "MC.123456.0212091345.533604",
        
			"original_source_id":  "MC.123456.0212091345.533604",
        
			"server_date":  "2023-02-13T15:00:29",
        
			"date_utc":  "2023-02-13T15:00:29",
        
			"mode":  1,
        
			"host_message_type":  2,
        
			"host_message_desc":  "NAME-CHEAP.COM* KO28384600 East Washington Street, Suite 305PHOENIX85034     AZ USA",
        
			"transaction_indicator":  6,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  false
			
    },
    
			"host_message":  {
        
			"iso_data":  {
            
			"h.ReplyTo":  null,
            
			"d":  null,
            
			"000":  "1240",
            
			"002":  null,
            
			"003":  "00",
            
			"004":  "000000001476",
            
			"005":  null,
            
			"006":  "000000001384",
            
			"007":  null,
            
			"008":  null,
            
			"009":  null,
            
			"010":  null,
            
			"011":  null,
            
			"012":  "230213030409",
            
			"013":  null,
            
			"014":  null,
            
			"015":  null,
            
			"016":  null,
            
			"017":  null,
            
			"018":  null,
            
			"019":  null,
            
			"020":  null,
            
			"021":  null,
            
			"022":  null,
            
			"023":  null,
            
			"024":  null,
            
			"025":  null,
            
			"026":  null,
            
			"027":  null,
            
			"028":  null,
            
			"029":  null,
            
			"030":  null,
            
			"031":  null,
            
			"032":  null,
            
			"033":  null,
            
			"034":  null,
            
			"035":  null,
            
			"036":  null,
            
			"037":  null,
            
			"038":  "497148",
            
			"039":  null,
            
			"040":  null,
            
			"041":  null,
            
			"042":  null,
            
			"043":  "NAME-CHEAP.COM* KO28384600 East Washington Street, Suite 305PHOENIX85034     AZ USA",
            
			"044":  null,
            
			"045":  null,
            
			"046":  null,
            
			"047":  null,
            
			"048":  null,
            
			"049":  "840",
            
			"050":  null,
            
			"051":  "978",
            
			"052":  null,
            
			"053":  null,
            
			"054":  null,
            
			"055":  null,
            
			"056":  null,
            
			"057":  null,
            
			"058":  null,
            
			"059":  null,
            
			"060":  null,
            
			"061":  null,
            
			"062":  null,
            
			"063":  null,
            
			"064":  null,
            
			"065":  null,
            
			"066":  null,
            
			"067":  null,
            
			"068":  null,
            
			"069":  null,
            
			"070":  null,
            
			"071":  null,
            
			"072":  null,
            
			"073":  null,
            
			"074":  null,
            
			"075":  null,
            
			"076":  null,
            
			"077":  null,
            
			"078":  null,
            
			"079":  null,
            
			"080":  null,
            
			"081":  null,
            
			"082":  null,
            
			"083":  null,
            
			"084":  null,
            
			"085":  null,
            
			"086":  null,
            
			"087":  null,
            
			"088":  null,
            
			"089":  null,
            
			"090":  null,
            
			"091":  null,
            
			"092":  null,
            
			"093":  null,
            
			"094":  null,
            
			"095":  null,
            
			"096":  null,
            
			"097":  null,
            
			"098":  null,
            
			"099":  null,
            
			"100":  null,
            
			"101":  null,
            
			"102":  null,
            
			"103":  null,
            
			"104":  null,
            
			"105":  null,
            
			"106":  null,
            
			"107":  null,
            
			"108":  null,
            
			"109":  null,
            
			"110":  null,
            
			"111":  null,
            
			"112":  null,
            
			"113":  null,
            
			"114":  null,
            
			"115":  null,
            
			"116":  null,
            
			"117":  null,
            
			"118":  null,
            
			"119":  null,
            
			"120":  null,
            
			"121":  null,
            
			"122":  null,
            
			"123":  null,
            
			"124":  null,
            
			"125":  null,
            
			"126":  null,
            
			"127":  null,
            
			"128":  null,
            
			"048.13":  null,
            
			"048.17":  null,
            
			"048.20":  null,
            
			"048.26":  null,
            
			"048.30":  null,
            
			"048.33":  null,
            
			"048.38":  null,
            
			"048.42":  null,
            
			"048.43":  null,
            
			"048.61":  null,
            
			"048.63":  null,
            
			"048.71":  null,
            
			"048.72":  null,
            
			"048.77":  null,
            
			"048.80":  null,
            
			"048.82":  null,
            
			"048.83":  null,
            
			"048.84":  null,
            
			"048.87":  null,
            
			"048.89":  null,
            
			"048.92":  null,
            
			"048.98":  null,
            
			"048.99":  null
			
        },
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  2608426,
                
			"parent_id":  0,
                
			"account_id":  123456,
                
			"user_id":  123456,
                
			"pos_id":  0,
                
			"status":  2,
                
			"type":  48,
                
			"classification":  "Withdrawal",
                
			"operation":  "Debit",
                
			"amount":  "14.19",
                
			"currency":  "EUR",
                
			"balance":  "72.70",
                
			"available_balance":  "31.40",
                
			"notes":  "Purchase for 14.76 (USD) - on 02-12 - NAME-CHEAP.COM* KO2838 +13233752822  AZ",
                
			"original_source_id":  "MC.123456.0212091345.533604",
                
			"server_date":  "2023-02-13T14:53:50",
                
			"date_utc":  "2023-02-13T14:53:50",
                
			"auth_date_utc":  "2023-02-12T09:13:46",
                
			"post_date_utc":  "2023-02-13T14:53:50",
                
			"client_date":  "2023-02-13T14:53:50",
                
			"auth_client_date":  "2023-02-12T09:13:46",
                
			"post_client_date":  "2023-02-13T14:53:50",
                
			"source_time_zone":  "",
                
			"service_provider":  0
			
            },
            
			"account":  {
                
			"result":  null,
                
			"info":  {
                    
			"id":  123456,
                    
			"supplied_id":  321654,
                    
			"program_id":  1234,
                    
			"bin_id":  "1111",
                    
			"user_id":  123456,
                    
			"name":  "Debit Card",
                    
			"nick_name":  null,
                    
			"type":  "0",
                    
			"number":  null,
                    
			"card_image":  null,
                    
			"currency":  "EUR",
                    
			"status":  "1",
                    
			"usage_status":  "1",
                    
			"balance":  "72.70",
                    
			"available_balance":  "31.40",
                    
			"activation_date_time":  "2023-02-13",
                    
			"replace_account":  null,
                    
			"original_source_id":  "00000000000000000000000000000000-irIuthYyMLgRVj",
                    
			"server_date":  "2022-10-13T09:48:28",
                    
			"date_utc":  "2022-10-13T08:48:28",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +00:00",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"limits":  null,
                
			"archive":  null,
                
			"custom_field":  null,
                
			"geo_coordinates":  null,
                
			"options":  null,
                
			"bank_account":  null,
                
			"history":  null,
                
			"fulfilment":  null,
                
			"access_rule":  null,
                
			"notes":  null,
                
			"last_activity":  null,
                
			"authentication":  null,
                
			"validate":  null,
                
			"function_code":  0,
                
			"time_zone":  null,
                
			"time_zone_name":  null,
                
			"response_time":  0
			
            },
            
			"fee":  {
                
			"id":  2608427,
                
			"fee_definition_id":  16366,
                
			"amount":  "0.50",
                
			"type":  49,
                
			"operation":  "Debit",
                
			"notes":  "Fee - Purchase"
			
            },
            
			"tax":  null,
            
			"conversion":  {
                
			"from_currency":  "USD",
                
			"to_currency":  "EUR",
                
			"original_amount":  "14.76",
                
			"first_converted_amount":  "0.00",
                
			"converted_amount":  "14.19",
                
			"first_converted_amount_without_margin":  "0.00",
                
			"converted_amount_without_margin":  "0.00",
                
			"conversion_type":  0,
                
			"ws_setup_id":  0,
                
			"currency_rate":  "1.0402",
                
			"second_currency_rate":  "0.0000",
                
			"margin_percent":  0.0,
                
			"second_margin_percent":  0.0,
                
			"margin_percent_from_base":  0.0
			
            },
            
			"exchange":  null,
            
			"transfer":  null,
            
			"credit_card":  null,
            
			"bank_account":  null,
            
			"crypto_wallet":  null,
            
			"payment_info":  null,
            
			"payment_gateway":  null,
            
			"custom_field":  {
                
			"iso_data":  {
                    
			"Message":  {
                        
			"000":  "1240",
                        
			"003":  "00",
                        
			"012":  "230213030409",
                        
			"038":  "497148",
                        
			"043":  "NAME-CHEAP.COM* KO28384600 East Washington Street, Suite 305PHOENIX85034     AZ USA",
                        
			"049":  "840",
                        
			"051":  "978"
			
                    }
			
                }
			
            },
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"Po6cF0mZO882u3Ng==\",\"Content-Type\":\"application/json\",\"source_id\":\"c7f574b6-9857-4808-b937-a71f5d5ec40b\",\"time_zone\":\"UTC +01:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/transaction/2608426",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Organization Change Notification

Organization Change Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2712318,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  15,
        
			"entity_id":  117045,
        
			"entity_data":  -1,
        
			"operation_type":  3,
        
			"source_id":  "b226afc3-182b-4d9f-8a0d-493ca9542a25",
        
			"original_source_id":  "b226afc3-182b-4d9f-8a0d-493ca9542a25",
        
			"server_date":  "2022-11-16T14:58:39",
        
			"date_utc":  "2022-11-16T14:58:39",
        
			"mode":  1,
        
			"host_message_type":  12,
        
			"host_message_desc":  "Organization ID: 463 - Address updated successfully - Type (Home) (ID 117045)",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  null,
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  {
            
			"result":  null,
            
			"info":  {
                
			"id":  463,
                
			"program_id":  1234,
                
			"entity":  7,
                
			"entity_id":  123456,
                
			"name":  "Link Consultants Group Holdings CY Limited",
                
			"local_name":  "Link Consultants Group Holdings CY Limited",
                
			"status":  1,
                
			"verification_status":  0,
                
			"type":  3,
                
			"server_date":  "2022-11-16T14:58:39",
                
			"date_utc":  "2022-11-16T14:58:39",
                
			"source_time_zone":  "UTC +02:00",
                
			"source_id":  "b226afc3-182b-4d9f-8a0d-493ca9542a25"
			
            },
            
			"details":  null,
            
			"address":  [
                
			{
                    
			"id":  117045,
                    
			"type":  0,
                    
			"is_primary":  1,
                    
			"is_billing":  1,
                    
			"address_line1":  "28 Oktovriou, 243 CHRISTIANA SEA VIEW COURT, 3rd floor, Flat/Office 301-302  . 3035, Limassol, Cypru",
                    
			"address_line2":  "",
                    
			"postal_zip_code":  "3035",
                    
			"country_code":  "196",
                    
			"state_region":  "",
                    
			"city_town":  "Limassol",
                    
			"status":  1,
                    
			"verification_status":  1,
                    
			"original_source_id":  "d32f4c6b-764b-4afa-874b-b42c2924c588",
                    
			"server_date":  "2022-11-09T10:03:45",
                    
			"date_utc":  "2022-11-09T10:03:45",
                    
			"client_date":  null,
                    
			"update_date_utc":  "2022-11-16T14:58:39",
                    
			"custom_field":  null
			
                }
			
            ],
            
			"email":  null,
            
			"phone":  null,
            
			"social_media":  null,
            
			"ownership_json":  null,
            
			"classification":  null,
            
			"working_hours":  null,
            
			"json":  null,
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"relationship":  null,
            
			"documents":  null,
            
			"picture":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        }
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"s2k3NYpZ+OUjFfrALn+3Ig==\",\"Content-Type\":\"application/json\",\"source_id\":\"a86addfb-8b4c-43d4-b40b-7241414ead92\",\"time_zone\":\"UTC +02:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/organization/address/463",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Payment Gateway Notification

Payment Gateway Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2866067,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  11,
        
			"entity_id":  2608569,
        
			"entity_data":  -1,
        
			"operation_type":  1,
        
			"source_id":  "WH.230214.5233e804-19fb-4248-b9b2-e15c55a86af3",
        
			"original_source_id":  "WH.230214.5233e804-19fb-4248-b9b2-e15c55a86af3",
        
			"server_date":  "2023-02-14T07:03:07",
        
			"date_utc":  "2023-02-14T07:03:07",
        
			"mode":  1,
        
			"host_message_type":  9,
        
			"host_message_desc":  "Payment Gateway Load - 40.00 (GBP) 230214347181",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  2608569,
                
			"parent_id":  0,
                
			"account_id":  123456,
                
			"user_id":  123456,
                
			"pos_id":  0,
                
			"status":  2,
                
			"type":  234,
                
			"classification":  "Deposit",
                
			"operation":  "Credit",
                
			"amount":  "40.00",
                
			"currency":  "GBP",
                
			"balance":  "96.78",
                
			"available_balance":  "96.78",
                
			"notes":  "Payment Gateway Load - 40.00 (GBP) 230214347181",
                
			"original_source_id":  "WH.230214.5233e804-19fb-4248-b9b2-e15c55a86af3",
                
			"server_date":  "2023-02-14T07:02:56",
                
			"date_utc":  "2023-02-14T07:02:56",
                
			"auth_date_utc":  "2023-02-14T07:02:55",
                
			"post_date_utc":  "2023-02-14T07:02:56",
                
			"client_date":  "2023-02-14T07:02:56",
                
			"auth_client_date":  "2023-02-14T07:02:55",
                
			"post_client_date":  "2023-02-14T07:02:56",
                
			"source_time_zone":  "UTC +01:00",
                
			"service_provider":  0
			
            },
            
			"account":  {
                
			"result":  null,
                
			"info":  {
                    
			"id":  123456,
                    
			"supplied_id":  321654,
                    
			"program_id":  1234,
                    
			"bin_id":  "1111",
                    
			"user_id":  123456,
                    
			"name":  "Debit Card",
                    
			"nick_name":  null,
                    
			"type":  "0",
                    
			"number":  "537585******0339",
                    
			"card_image":  null,
                    
			"currency":  "GBP",
                    
			"status":  "12",
                    
			"usage_status":  "12",
                    
			"balance":  "96.78",
                    
			"available_balance":  "96.78",
                    
			"activation_date_time":  "2022-09-21",
                    
			"replace_account":  null,
                    
			"original_source_id":  "moto-mobile-live2-4a1b3e9a-f397-46b6-9782-2dd5e6f5b058",
                    
			"server_date":  "2022-09-21T12:52:43",
                    
			"date_utc":  "2022-09-21T11:52:43",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +05:30",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"limits":  null,
                
			"archive":  null,
                
			"custom_field":  null,
                
			"geo_coordinates":  null,
                
			"options":  null,
                
			"bank_account":  null,
                
			"history":  null,
                
			"fulfilment":  null,
                
			"access_rule":  null,
                
			"notes":  null,
                
			"last_activity":  null,
                
			"authentication":  null,
                
			"validate":  null,
                
			"function_code":  0,
                
			"time_zone":  null,
                
			"time_zone_name":  null,
                
			"response_time":  0
			
            },
            
			"fee":  null,
            
			"tax":  null,
            
			"conversion":  {
                
			"from_currency":  "GBP",
                
			"to_currency":  "GBP",
                
			"original_amount":  "40.00",
                
			"first_converted_amount":  "0.00",
                
			"converted_amount":  "40.00",
                
			"first_converted_amount_without_margin":  "0.00",
                
			"converted_amount_without_margin":  "40.00",
                
			"conversion_type":  4,
                
			"ws_setup_id":  0,
                
			"currency_rate":  "1.0000",
                
			"second_currency_rate":  "1.0000",
                
			"margin_percent":  0.0,
                
			"second_margin_percent":  0.0,
                
			"margin_percent_from_base":  0.0
			
            },
            
			"exchange":  null,
            
			"transfer":  null,
            
			"credit_card":  null,
            
			"bank_account":  null,
            
			"crypto_wallet":  null,
            
			"payment_info":  null,
            
			"payment_gateway":  {
                
			"info":  {
                    
			"id":  0,
                    
			"type":  37,
                    
			"service_type":  0,
                    
			"reverse_type":  0,
                    
			"post_datetime_utc":  null,
                    
			"request_source_app":  0
			
                },
                
			"open_payd":  {
                    
			"transaction_id":  "0965ce13-904a-4c77-91e3-9c24472dcd65",
                    
			"transaction_type":  "PAYIN",
                    
			"status":  "COMPLETED",
                    
			"transaction_datetime":  "2023-02-14T07:02:54.44433",
                    
			"transaction_reference":  "230214347181",
                    
			"sender_bic":  "QpH2AjvNF6VLPyG26BT3QA==",
                    
			"sender_iban":  "JreEpUlrxcRQHQzFkmyGkKxP/MB2DVXLX4mkDi2yL5U=",
                    
			"sender_name":  "S Marsh",
                    
			"internal_account_id":  "GBP00882723935826",
                    
			"beneficiary_account_holder_name":  "STEPHEN MORTON MARSH",
                    
			"primary_account":  {
                        
			"id":  "Z05KUzB4NW50OWtrcG1mWGtOcFB6QT09",
                        
			"internal_account_id":  "GBP19454442641826",
                        
			"friendly_name":  "Moto",
                        
			"balance":  250.0,
                        
			"available_balance":  250.0,
                        
			"currency":  "GBP"
			
                    }
			
                },
                
			"currency_cloud":  null,
                
			"snb":  null,
                
			"binance":  null,
                
			"anb":  null,
                
			"coinify":  null,
                
			"peoples":  null,
                
			"hala":  null,
                
			"mada":  null
			
            },
            
			"custom_field":  null,
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"KLjZyZk3eIzqQf7VJs5nkX0E0UNkBA==\",\"Content-Type\":\"application/json\",\"source_id\":\"2e1ca33d-57c1-42d9-9dde-22734be615c6\",\"time_zone\":\"UTC +01:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/transaction/2608569",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Service Fee Notification

Service Fee Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2843612,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  11,
        
			"entity_id":  0,
        
			"entity_data":  -1,
        
			"operation_type":  1,
        
			"source_id":  "TS.230201.311524",
        
			"original_source_id":  "TS.230201.311524",
        
			"server_date":  "2023-02-01T01:11:06",
        
			"date_utc":  "2023-02-01T01:11:06",
        
			"mode":  1,
        
			"host_message_type":  13,
        
			"host_message_desc":  "Transaction Failed, Insufficient Funds.",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  {
            
			"result":  {
                
			"code":  "4008",
                
			"message":  "Insufficient Funds.",
                
			"friendly_message":  "Insufficient Funds."
			
            },
            
			"info":  {
                
			"id":  0,
                
			"parent_id":  0,
                
			"account_id":  123456,
                
			"user_id":  123456,
                
			"pos_id":  0,
                
			"status":  1,
                
			"type":  0,
                
			"classification":  "",
                
			"operation":  "Debit",
                
			"amount":  "0.00",
                
			"currency":  "GBP",
                
			"balance":  "0.00",
                
			"available_balance":  "0.00",
                
			"notes":  "0",
                
			"original_source_id":  "0",
                
			"server_date":  "1900-01-01T00:00:00",
                
			"date_utc":  "1900-01-01T00:00:00",
                
			"auth_date_utc":  "2023-02-01T01:11:06",
                
			"post_date_utc":  "2023-02-01T01:11:06",
                
			"client_date":  "1900-01-01T00:00:00",
                
			"auth_client_date":  "2023-02-01T01:11:06",
                
			"post_client_date":  "2023-02-01T01:11:06",
                
			"source_time_zone":  "0",
                
			"service_provider":  0
			
            },
            
			"account":  {
                
			"result":  null,
                
			"info":  {
                    
			"id":  123456,
                    
			"supplied_id":  321654,
                    
			"program_id":  1234,
                    
			"bin_id":  "1111",
                    
			"user_id":  123456,
                    
			"name":  "Debit Card",
                    
			"nick_name":  null,
                    
			"type":  "0",
                    
			"number":  "537585******9781",
                    
			"card_image":  null,
                    
			"currency":  "GBP",
                    
			"status":  "1",
                    
			"usage_status":  "1",
                    
			"balance":  "4.50",
                    
			"available_balance":  "4.50",
                    
			"activation_date_time":  "2022-03-06",
                    
			"replace_account":  null,
                    
			"original_source_id":  "create_account-bb0977ef-87dc-4a33-911f-0d7f0924f228",
                    
			"server_date":  "2022-02-09T17:13:08",
                    
			"date_utc":  "2022-02-09T17:13:08",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +02:00",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"limits":  null,
                
			"archive":  null,
                
			"custom_field":  null,
                
			"geo_coordinates":  null,
                
			"options":  null,
                
			"bank_account":  null,
                
			"history":  null,
                
			"fulfilment":  null,
                
			"access_rule":  null,
                
			"notes":  null,
                
			"last_activity":  null,
                
			"authentication":  null,
                
			"validate":  null,
                
			"function_code":  0,
                
			"time_zone":  null,
                
			"time_zone_name":  null,
                
			"response_time":  0
			
            },
            
			"fee":  {
                
			"id":  0,
                
			"fee_definition_id":  16085,
                
			"amount":  "4.99",
                
			"type":  -1,
                
			"operation":  "Debit",
                
			"notes":  "Fee"
			
            },
            
			"tax":  null,
            
			"conversion":  {
                
			"from_currency":  "GBP",
                
			"to_currency":  "GBP",
                
			"original_amount":  "0.00",
                
			"first_converted_amount":  "0.00",
                
			"converted_amount":  "0.00",
                
			"first_converted_amount_without_margin":  "0.00",
                
			"converted_amount_without_margin":  "0.00",
                
			"conversion_type":  0,
                
			"ws_setup_id":  0,
                
			"currency_rate":  "1.0000",
                
			"second_currency_rate":  "0.0000",
                
			"margin_percent":  0.0,
                
			"second_margin_percent":  0.0,
                
			"margin_percent_from_base":  0.0
			
            },
            
			"exchange":  null,
            
			"transfer":  null,
            
			"credit_card":  null,
            
			"bank_account":  null,
            
			"crypto_wallet":  null,
            
			"payment_info":  null,
            
			"payment_gateway":  null,
            
			"custom_field":  null,
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  null,
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

System Financial Notification

System Financial Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2864126,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  11,
        
			"entity_id":  2607318,
        
			"entity_data":  -1,
        
			"operation_type":  1,
        
			"source_id":  "transaction_action-7b839580-507d-4e13-bd19-c7118c882b37",
        
			"original_source_id":  "transaction_action-7b839580-507d-4e13-bd19-c7118c882b37",
        
			"server_date":  "2023-02-12T20:37:32",
        
			"date_utc":  "2023-02-12T20:37:32",
        
			"mode":  1,
        
			"host_message_type":  3,
        
			"host_message_desc":  "Transfer 20.00 (GBP) From Michael  akeredolu (User ID 123456) (Account ID 123456) To Michael  akeredolu (User ID 123456) (Account ID 288888) Balance transfer",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  2607318,
                
			"parent_id":  0,
                
			"account_id":  123456,
                
			"user_id":  123456,
                
			"pos_id":  0,
                
			"status":  2,
                
			"type":  220,
                
			"classification":  "Transfer Internal Send",
                
			"operation":  "Debit",
                
			"amount":  "20.00",
                
			"currency":  "GBP",
                
			"balance":  "144.95",
                
			"available_balance":  "144.95",
                
			"notes":  "Transfer 20.00 (GBP) From Michael  akeredolu (User ID 123456) (Account ID 123456) To Michael  akeredolu (User ID 123456) (Account ID 288888) Balance transfer",
                
			"original_source_id":  "transaction_action-7b839580-507d-4e13-bd19-c7118c882b37",
                
			"server_date":  "2023-02-12T20:37:22",
                
			"date_utc":  "2023-02-12T20:37:22",
                
			"auth_date_utc":  "2023-02-12T20:37:21",
                
			"post_date_utc":  "2023-02-12T20:37:22",
                
			"client_date":  "2023-02-12T20:37:22",
                
			"auth_client_date":  "2023-02-12T20:37:21",
                
			"post_client_date":  "2023-02-12T20:37:22",
                
			"source_time_zone":  "UTC +02:00",
                
			"service_provider":  0
			
            },
            
			"account":  {
                
			"result":  null,
                
			"info":  {
                    
			"id":  123456,
                    
			"supplied_id":  321654,
                    
			"program_id":  1234,
                    
			"bin_id":  "1111",
                    
			"user_id":  123456,
                    
			"name":  "E-Wallet",
                    
			"nick_name":  null,
                    
			"type":  "1",
                    
			"number":  "182607*********6775",
                    
			"card_image":  null,
                    
			"currency":  "GBP",
                    
			"status":  "1",
                    
			"usage_status":  "1",
                    
			"balance":  "144.95",
                    
			"available_balance":  "144.95",
                    
			"activation_date_time":  "2022-11-04",
                    
			"replace_account":  null,
                    
			"original_source_id":  "create_user-1fa2ac1e-8df4-423f-adb1-cd35397a9e34",
                    
			"server_date":  "2022-11-04T11:28:27",
                    
			"date_utc":  "2022-11-04T11:28:27",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +02:00",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"limits":  null,
                
			"archive":  null,
                
			"custom_field":  null,
                
			"geo_coordinates":  null,
                
			"options":  null,
                
			"bank_account":  null,
                
			"history":  null,
                
			"fulfilment":  null,
                
			"access_rule":  null,
                
			"notes":  null,
                
			"last_activity":  null,
                
			"authentication":  null,
                
			"validate":  null,
                
			"function_code":  0,
                
			"time_zone":  null,
                
			"time_zone_name":  null,
                
			"response_time":  0
			
            },
            
			"fee":  null,
            
			"tax":  null,
            
			"conversion":  {
                
			"from_currency":  "GBP",
                
			"to_currency":  "GBP",
                
			"original_amount":  "20.00",
                
			"first_converted_amount":  "0.00",
                
			"converted_amount":  "20.00",
                
			"first_converted_amount_without_margin":  "0.00",
                
			"converted_amount_without_margin":  "20.00",
                
			"conversion_type":  4,
                
			"ws_setup_id":  1,
                
			"currency_rate":  "1.0000",
                
			"second_currency_rate":  "0.0000",
                
			"margin_percent":  0.0,
                
			"second_margin_percent":  0.0,
                
			"margin_percent_from_base":  0.0
			
            },
            
			"exchange":  null,
            
			"transfer":  {
                
			"account_info":  {
                    
			"id":  288888,
                    
			"supplied_id":  487225,
                    
			"program_id":  1234,
                    
			"bin_id":  "1506",
                    
			"user_id":  123456,
                    
			"name":  "Debit Card",
                    
			"nick_name":  null,
                    
			"type":  "0",
                    
			"number":  "537585******6856",
                    
			"card_image":  null,
                    
			"currency":  "GBP",
                    
			"status":  "1",
                    
			"usage_status":  "1",
                    
			"balance":  "44.00",
                    
			"available_balance":  "20.84",
                    
			"activation_date_time":  null,
                    
			"replace_account":  null,
                    
			"original_source_id":  "create_account-8c932128-6726-4979-8d10-e2bf0478ed98",
                    
			"server_date":  "2022-11-04T13:02:58",
                    
			"date_utc":  "2022-11-04T13:02:58",
                    
			"client_date":  null,
                    
			"source_time_zone":  "UTC +02:00",
                    
			"security":  null,
                    
			"is_multi_currency":  null
			
                },
                
			"receiver_info":  {
                    
			"email":  "oye.ltd@hotmail.com",
                    
			"phone_number":  "+447903194297",
                    
			"first_name":  "Michael ",
                    
			"last_name":  "akeredolu",
                    
			"user_name":  "oye.ltd@hotmail.com"
			
                },
                
			"fee":  null,
                
			"tax":  null,
                
			"conversion":  null,
                
			"notes":  null
			
            },
            
			"credit_card":  null,
            
			"bank_account":  null,
            
			"crypto_wallet":  null,
            
			"payment_info":  null,
            
			"payment_gateway":  null,
            
			"custom_field":  null,
            
			"geo_coordinates":  null,
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"ezsrLuPhHlPO0QMcirA0g==\",\"Content-Type\":\"application/json\",\"source_id\":\"c1abd447-9603-4333-a722-0ef54d010e14\",\"time_zone\":\"UTC +02:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/transaction/2607318",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

Ticket Notification

Ticket Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2858345,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  7,
        
			"entity_id":  123456,
        
			"entity_data":  19,
        
			"operation_type":  1,
        
			"source_id":  "create_user-27453a48-f399-4d53-9476-4e7767873bbf",
        
			"original_source_id":  "create_user-27453a48-f399-4d53-9476-4e7767873bbf",
        
			"server_date":  "2023-02-09T11:10:17",
        
			"date_utc":  "2023-02-09T11:10:17",
        
			"mode":  1,
        
			"host_message_type":  11,
        
			"host_message_desc":  "Upload Identification With Selfie Picture",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  false
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  null,
        
			"account_data":  null,
        
			"transaction_data":  null,
        
			"order_data":  null,
        
			"ticket_data":  {
            
			"result":  {
                
			"code":  "0000",
                
			"message":  "Operation Completed Successfully.",
                
			"friendly_message":  "Operation Completed Successfully."
			
            },
            
			"info":  {
                
			"id":  1380,
                
			"cluster_id":  0,
                
			"program_id":  1234,
                
			"parent_id":  0,
                
			"entity":  7,
                
			"entity_id":  123456,
                
			"sub_entity":  [
                    
			{
                        
			"sub_entity":  25,
                        
			"sub_entity_id":  0
			
                    }
			
                ],
                
			"by_entity":  3,
                
			"by_entity_id":  2766,
                
			"assigned_to_entity":  7,
                
			"assigned_to_entity_id":  123456,
                
			"entity_data":  19,
                
			"status":  1,
                
			"description_code":  "M102",
                
			"category":  2,
                
			"type":  1,
                
			"scope":  3,
                
			"priority":  2,
                
			"service_provider":  20,
                
			"service_method":  4,
                
			"server_date":  "2023-02-09T11:10:17",
                
			"date_utc":  "2023-02-09T11:10:17",
                
			"client_date":  "2023-02-09T13:10:17",
                
			"update_date_utc":  "2023-02-09T11:10:17",
                
			"source_time_zone":  "UTC +02:00",
                
			"original_source_id":  "create_user-27453a48-f399-4d53-9476-4e7767873bbf"
			
            },
            
			"content":  {
                
			"subject":  "Upload Identification With Selfie Picture",
                
			"content":  "To verify your identity, please upload an identification with selfie picture, for example: Driver license, Passport or National ID.\r\n\r\nDocument Tips :\r\n\r\n1) There should be sufficient light and avoid glare on the image.\r\n2) Ensure the image is not blurred.\r\n3) Make sure your full Document is within the image.\r\n4) All edges of the document should be within the frame.\r\n5) Make sure that document number and expiry date are clearly visible.\r\n6) Don’t edit the image Don’t hide, fold or crop any part of the document.\r\n7) Make sure your face is fully and clearly visible.\r\n8) Ensure that the image position is horizontal in which the picture can be seen naturally."
			
            },
            
			"history":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  "UTC +02:00",
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"12NwuKXm7gUoqxGQIrA==\",\"Content-Type\":\"application/json\",\"source_id\":\"61c66510-aa56-4b34-8bd1-aef63ac5e6fd\",\"time_zone\":\"UTC +02:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/ticket/1380",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×

User Change Notification

User Change Notification


Configuration Header:
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
  • show_custom_field : 1
Configuration Query Parameters:
Request Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  2865454,
        
			"program_id":  1234,
        
			"user_id":  123456,
        
			"entity":  26,
        
			"entity_id":  67821,
        
			"entity_data":  1,
        
			"operation_type":  1,
        
			"source_id":  "M.230213.M2920.921944",
        
			"original_source_id":  "M.230213.M2920.921944",
        
			"server_date":  "2023-02-13T13:41:56",
        
			"date_utc":  "2023-02-13T13:41:56",
        
			"mode":  1,
        
			"host_message_type":  4,
        
			"host_message_desc":  "User ID: 123456 - New Document added successfully - Type (Other) (ID 67821)",
        
			"transaction_indicator":  0,
        
			"status":  1,
        
			"delivery_status":  1,
        
			"stand_in":  false,
        
			"sending_count":  3,
        
			"api_key":  "W3jkjQmW9FtqwK8XJMdls=",
        
			"includes_sensitive_data":  true
			
    },
    
			"host_message":  {
        
			"iso_data":  null,
        
			"user_data":  {
            
			"result":  null,
            
			"info":  {
                
			"id":  123456,
                
			"program_id":  1234,
                
			"status":  null,
                
			"type":  1,
                
			"server_date":  null,
                
			"date_utc":  null,
                
			"client_date":  null,
                
			"source_time_zone":  null,
                
			"original_source_id":  null
			
            },
            
			"personal_info":  null,
            
			"address":  null,
            
			"addresses":  null,
            
			"email":  null,
            
			"phone":  null,
            
			"security":  null,
            
			"preferences":  null,
            
			"identification":  null,
            
			"bank_account":  null,
            
			"credit_card":  null,
            
			"notification":  null,
            
			"documents":  [
                
			{
                    
			"result":  {
                        
			"code":  "0000",
                        
			"message":  "Operation Completed Successfully.",
                        
			"friendly_message":  "Operation Completed Successfully."
			
                    },
                    
			"info":  {
                        
			"program_id":  1234,
                        
			"user_id":  123456,
                        
			"entity":  60,
                        
			"entity_id":  0,
                        
			"document_id":  67821,
                        
			"first_name":  "Caroline",
                        
			"last_name":  "Randall",
                        
			"email_address":  "carolinerandall10@gmail.com",
                        
			"type":  12,
                        
			"language":  null,
                        
			"status":  1,
                        
			"subject":  "Caroline Randall selfie",
                        
			"notes":  "",
                        
			"number_of_attachments":  1,
                        
			"support_notes":  null,
                        
			"update_datetime_utc":  null,
                        
			"source_id":  null,
                        
			"server_date":  null,
                        
			"date_utc":  null,
                        
			"source_time_zone":  null,
                        
			"attachment_status":  2
			
                    },
                    
			"attachment":  [
                        
			{
                            
			"file_name":  "Image (1)",
                            
			"file_extension":  ".jpeg",
                            
			"content":  "____",
                            
			"file_id":  83614,
                            
			"file_url":  null,
                            
			"is_selfie":  true
			
                        }
			
                    ],
                    
			"custom_field":  null,
                    
			"geo_coordinates":  null,
                    
			"notes":  null,
                    
			"last_activity":  null,
                    
			"authentication":  null,
                    
			"validate":  null,
                    
			"function_code":  0,
                    
			"time_zone":  "UTC +01:00",
                    
			"time_zone_name":  null,
                    
			"response_time":  0
			
                }
			
            ],
            
			"currency":  null,
            
			"account":  null,
            
			"group":  null,
            
			"terms_conditions":  null,
            
			"device_info":  null,
            
			"commerce":  null,
            
			"external_auth":  null,
            
			"validation_data":  null,
            
			"relationship":  null,
            
			"geo_coordinates":  null,
            
			"custom_field":  null,
            
			"history":  null,
            
			"access_rule":  null,
            
			"ticket":  null,
            
			"general_requirements":  null,
            
			"organization":  null,
            
			"notes":  null,
            
			"last_activity":  null,
            
			"authentication":  null,
            
			"validate":  null,
            
			"function_code":  0,
            
			"time_zone":  null,
            
			"time_zone_name":  null,
            
			"response_time":  0
			
        },
        
			"account_data":  null,
        
			"transaction_data":  null,
        
			"order_data":  null,
        
			"ticket_data":  null,
        
			"otp_authentication_data":  null,
        
			"fee_definition":  null,
        
			"conversion":  null,
        
			"blocking_details":  null,
        
			"organization_data":  null
			
    },
    
			"webhook":  {
        
			"headers":  "{\"Authorization\":\"oNt7qk1isdJQA+ZQ==\",\"Content-Type\":\"application/json\",\"source_id\":\"95b6be9b-988a-4cc4-b56e-74162cbbb369\",\"time_zone\":\"UTC +01:00\",\"language\":\"en\"}",
        
			"content_type":  "application/json",
        
			"url":  "https://demoapi.nuvopay.com/Service/v1/user/123456",
        
			"method":  "GET"
			
    },
    
			"network":  null
			
}
		
Response Parameters:

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    }
			
}
		
×