Dispute installment created
This event occurs when a dispute or dispute installment is created. Endpoints that generate this event include Create dispute and Create dispute installment
Type: object
Additional properties: false
Domain: disputes
Event: dispute_installment_creation
Version: 1
arn required
Title: ARN
Description: ARN - Acquirer reference number
Type: string or null
Example:
null
test-arn
chargeback_id required
Title: Chargeback ID
Description: Chargeback ID
Type: string or null
claim_id required
Title: Claim ID
Description: Claim ID
Type: string or null
dispute_id required
Title: Dispute ID
Description: Dispute ID
Type: integer
Example:
28890
dispute_status required
Title: Dispute status
Description: Dispute status object
Type: object
Additional properties: false
Example:{ "id": 4, "description": "SECOND_PRESENTMENT", "type": "PRIMITIVE", "group": "CARDNETWORK_SECOND_PRESENTMENT" }id
Title: Dispute status ID
Description: Dispute status ID
Type: integer or null
Example:
4description required
Title: Dispute status
Description: Dispute status enum - depends on state machine. For PRIMITIVE, they areOPENED PENDING CANCELED FAILED CHARGEBACK_REJECTED CHARGEBACK_CREATED CHARGEBACK_ACCEPTED CHARGEBACK_CLOSED SECOND_PRESENTMENT PRE_ARBITRATION_OPENED PRE_ARBITRATION_ACCEPTED PRE_ARBITRATION_DECLINED PRE_ARBITRATION_RECALL PRE_ARB_ALLOCATION_OPENED FAILED_PRE_ARBITRATION PRE_ARB_ALLOCATION_ACCEPTED PRE_ARB_ALLOCATION_DECLINED PRE_ARB_ALLOCATION_RECALLED FAILED_DECLINE_PRE_ARB FAILED_ACCEPT_PRE_ARB FAILED_ON_CLOSE EXPIRED ISSUER_LOSS
Type: string
Example:
PENDING
OPENEDtype
Title: State machine type
Description: Dispute state machine enum
Type: string
Must be one of the following:
MASTERCARD_CARD
TOK_PAG
PRIMITIVEgroup required
Title: Group dispute status
Description: Dispute group statuses
Type: string
Must be one of the following:
OPEN
APPROVED
DENIED
CARDNETWORK_CHARGEBACK
ANALYSING
CARDNETWORK_SECOND_PRESENTMENT
FAILED
CARDNETWORK_PREARBITRATION
RESEND
LOSS
WON
REJECTED
FAILED_PROCESSED
id required
Title: Installment ID
Description: Installment ID
Type: integer
Example:
178500
installment required
Title: Installment number
Description: Installment index number
Type: integer
Example:
2
installment_disputed_amount required
Title: Installment disputed amount
Description: Installment disputed amount
Type: number
Example:
1234.56
is_first_installment required
Title: First installment flag
Description: Is this the first installment flag
Type: boolean
Must be one of the following:
true
false
network_response_error required
Title: Network response error
Description: Network response error
Type: string or null
Example:
null
The network returned [This field has an invalid input length.], reasonCode [INVALID_INPUT_LENGTH] with the source [acquirerRefNumber].
network_return_reason_code required
Title: Network return reason code
Description: Network return reason code
Type: string or null
Example:
null
422
2002
4853
CO1
network_return_reject_reason required
Title: Network return reject reason
Description: Network return reject reason
Type: string or null
Example:
null
Code1=0283(00):D0025/000;DE072=D0025\4837\\
Code1=2226(00): D0002/000;Code2=0631(00): P0158/004;Code3=2220(00): D0003/000;DE072=D0002\5214330278318136\\P0158\DE\\D0003\000000\\
Code1=5001(00): D0025/000;DE072=D0025\0000\\
Code1=5000(00): D0025/000;DE072=D0025\0000\\
network_return_reject_reason_code required
Title: Network return reject reason code
Description: Network return reject reason code
Type: integer or null
Example:
null
283
2226
5001
5000
reason_code required
Title: Reason code.
Description: Dispute reason code.
Type: integer or null
Example:
null
4837
4850
4808
4853
category
Title: Category
Description: Category - for ELO card network only
Type: string or null
Must be one of the following:
INSTALLMENT
AIRPORT_TAX
Example:
INSTALLMENT
chargeback_ref_num
Title: Chargeback reference number
Description: Chargeback reference number
Type: string or null
Example:
1234
dispute_due_to
Title: Dispute due to enum
Description: Dispute due to enums - VISA, reason code 13. For more details on these enums, see thedispute_due_toparameter for the Create dispute endpoint
Type: string or null
Must be one of the following:
CR
ND
DM
Q
CM
M
CN
CS
OC
CL
TC
D
IAN
IA
IC
IT
ID
LP
P
dispute_form
Title: Dispute form object
Type: object or null
Additional properties: false
Example:{ "id": 123, "status": "PENDING", "network": "MASTERCARD_CARD", "form": { "data": "jsonString" }, "dispute_installment_id": 123, "created_at": "2022-01-01 11:11:11", "created_at_utc": "2022-01-01 10:11:11", "updated_at": "2022-01-01 22:11:11", "updated_at_utc": "2022-01-01 23:11:11" }id
Title: Dispute form ID
Type: integer or null
Example:
123status
Title: Status
Type: string or null
Must be one of the following:
PENDING
PROCESSED
FAILED
INACTIVEnetwork
Title: Network
Description: Network state machine
Type: string or null
Must be one of the following:
MASTERCARD_CARD
TOK_PAG
PRIMITIVEform
Title: Form object
Type: object or null
Example:{ "data": "jsonString" }dispute_installment_id
Title: Dispute installment ID
Description: Dispute installment ID
Type: integer or null
Example:
123created_at
Title: Created at date/time
Description: Created at date/time
Type: string or null
Example:
2022-01-01 11:11:11created_at_utc
Title: Created at date/time
Description: Created at in UTC date/time
Type: string or null
Example:
2022-01-01 10:11:11updated_at
Title: Updated at date/time
Description: Updated at date/time
Type: string
Example:
2022-01-01 22:11:11updated_at_utc
Title: Updated at in UTC date/time
Description: Updated at in UTC date/time
Type: string
Example:
2022-01-01 23:11:11
dispute_form_id
Title: Dispute form ID
Description: Dispute form ID
Type: string or null
Example:
null
283
dispute_fraud_report
Title: Dispute fraud report object
Type: object or null
Additional properties: false
Example:{ "fraud_report_id": 123, "status": "PENDING", "network_brand_type": "Mastercard", "report": { "acct_status": "ACCT_IS_OPEN", "chgbk_indicator": "1", "cvc_invalid_indicator": "1", "device_type": "1", "fraud_type": "00", "report_date": "2021-02-11", "sub_type": "K" }, "fraud_report_network_id": 123, "created_at": "2022-01-01 11:11:11", "updated_at": "2022-01-01 22:11:11", "comment_network": "Comment here" }fraud_report_id
Title: Fraud report ID
Type: integer
Example:
12344status
Title: Status
Description: Dispute form status
Type: string or null
Must be one of the following:
PENDING
PROCESSED
FAILED
INACTIVEnetwork_brand_type
Title: Network brand
Description: Network brand - VISA or Mastercard
Type: string or null
Must be one of the following:
Mastercard
Visareport
Title: Report object
Description: Report object
Type: object or null
Example:{ "acct_status": "done", "chgbk_indicator": "1", "cvc_invalid_indicator": "1", "device_type": "1", "fraud_type": "00", "report_date": "2022-01-01", "sub_type": "k" }acct_status
Title: Account status
Description: Account status enum
Type: string or null
Must be one of the following:
ACCT_IS_OPEN
ACCT_HAS_BEEN_CLOSEDchgbk_indicator
Title: Chargeback indicator
Description: Is this a chargeback flag. true = '1', false = '0'
Type: string or null
Example:
1cvc_invalid_indicator
Title: CVC invalid indicator
Description: Mastercard CVC invalid code indicator
Type: string or null
Example:
1device_type
Title: Device type
Description: Mastercard device type
Type: string or null
Example:
Kfraud_type
Title: Fraud type
Description: Fraud type (link)
Type: string or null
Example:
00report_date
Title: Report date
Description: Report date
Type: string or null
Example:
2022-01-01sub_type
Title: Sub type
Description: Sub type (link)
Type: string or null
Example:
Kfraud_report_network_id
Title: Fraud report network ID
Description: Fraud report network ID
Type: integer
Example:
123created_at
Title: Created at date/time
Description: Created at date/time
Type: string or null
Example:
2022-01-01 11:11:11updated_at
Title: Updated at date/time
Description: Updated at date/time
Type: string or null
Example:
2022-01-01 22:11:11comment_network
Title: Network comment
Description: Network comment
Type: string or null
Example:
Comment here
fraud_type
Title: Fraud type enum
Description: Fraud type enums - VISA, reason code 10
Type: string or null
Must be one of the following:
0
1
2
3
4
5
6
A
B
C
D
document_indicator
Title: Document indicator flag
Description: Document submission indicator to Network ELO
Type: boolean
Must be one of the following:
true
false
network_response
Type: array or null
id
Title: ID
Type: integer or null
Example:
123dispute_id
Title: Pismo dispute ID
Description: Pismo dispute ID
Type: integer or null
Example:
1234dispute_installment_id
Title: Pismo dispute installment ID
Description: Pismo dispute installment ID
Type: integer or null
Example:
4321claim_id
Title: Claim ID
Description: Claim ID
Type: string or null
Example:
1345chargeback_id
Title: Chargeback ID
Description: Chargeback ID
Type: string or null
Example:
234aa234jalreason_code
Title: Reason code.
Description: Reason code.
Type: string or null
Example:
4853response_error
Title: Response error
Description: Response error
Type: string or null
Example:
Error createdreject_reason
Title: Reject reason
Description: Reject reason
Type: string or null
Example:
123
network_response_amount
Title: Network response amount
Description: Network response amount
Type: number or null
Example:
1234
network_response_currency
Title: Network response currency
Description: Network response currency code
Type: string or null
Example:
USD
BRL
network_status
Title: Dispute network status
Description: Dispute network status
Type: string or null
Example:
Authorization Dispute - Accepted by Acq
pre_arb_master
Title: Pre-abitration for Mastercard object
Type: object or null
Example:{ "pre_arbitration_response_id": 4, "memo": "This is a test memo", "updated_chargeback_reason_code": 2, "merchant_name": "MERCHANT", "filing_ica": "001234", "change_reason_code_reason": "4863", "case_network_response": "Ok", "dispute_amount": 100.0, "currency_code": "USD", "change_reason_code_flag": "Y", "acquirer_ref_num": "05131054165000000048149", "chargeback_reason_code": "4863" }pre_arbitration_response_id
Title: Pre arbitration response ID
Description: Pre arbitration response ID
Type: integer or null
Example:
4memo
Title: Pre-arb memo
Description: Pre-arbitration memo
Type: string or null
Example:
Who uses memos anymoreupdated_chargeback_reason_code
Title: Updated chargeback reason code
Description: Updated chargeback reason code
Type: integer or null
Example:
2merchant_name
Title: Merchant name
Description: Merchant name
Type: string or null
Example:
Acme Goodsfiling_ica
Title: ICA filing
Description: ICA filing
Type: string or null
Example:
001234change_reason_code_reason
Title: Change reason code reason
Description: Change reason code reason
Type: string or null
Example:
Explanation for reason code changecase_network_response
Title: Case network response
Description: Case network response
Type: string or null
Example:
Okdispute_amount
Title: Dispute amount
Description: Dispute amount
Type: number or null
Example:
100.0currency_code
Title: Currency code
Description: ISO currency code
Type: string or null
Example:
USDchange_reason_code_flag
Title: Change reason code flag
Description: Change reason code flag
Type: string or null
Example:
Yacquirer_ref_num
Title: Acquirer reference number
Description: Acquirer reference number
Type: string or null
Example:
05131054165000000048149chargeback_reason_code
Title: The chargeback_reason_code pre_arb_master schema
Type: string or null
Example:
4863
pre_arbitration
Title: Pre-arbitration object
Description: Pre-arbitration object
Type: object or null
Additional properties: false
Example:{ "pre_arbitration_id": 4, "memo": "This is a test memo", "acquirer_memo": "Memo from acquirer", "updated_chargeback_reason_code": 2, "merchant_name": "MERCHANT", "filing_ica": "001234", "change_reason_code_reason": "4863", "case_network_response": "Ok", "dispute_amount": 100.0, "change_reason_code_flag": "Y", "acquirer_ref_num": "05131054165000000048149", "network_pre_arbitration_id": "8484999587", "chargeback_reason_code": "4863", "currency_code_response": null, "currency_code_request": null, "is_partial": "1", "amount_request": "4", "amount_response": null, "justify_not_accepted_fully": "1" }pre_arbitration_id
Title: Pre arbitration ID
Description: Pre arbitration ID
Type: integer or null
Example:
49975acquirer_memo
Title: Acquirer memo
Description: Acquirer memo
Type: string or null
Example:
null
Memo from acquirer about this disputememo
Title: Pre-arbitration memo
Description: Pre-arbitration memo
Type: string or null
Example:
Who uses memos anymorenetwork_pre_arbitration_id
Title: Network pre-arbitration ID
Description: Network created pre-arbitration ID
Type: string or null
Example:
null
6789033989updated_chargeback_reason_code
Title: Updated chargeback reason code
Description: Updated chargeback reason code
Type: integer or null
Example:
2merchant_name
Title: Merchant name
Description: Merchant name
Type: string or null
Example:
Acme Goodsfiling_ica
Title: ICA filing
Description: ICA filing
Type: string or null
Example:
001234change_reason_code_reason
Title: Change reason code reason
Description: Change reason code reason
Type: string or null
Example:
4863case_network_response
Title: Case network response
Description: Case network response
Type: string or null
Example:
Okdispute_amount
Title: Dispute amount
Description: Dispute amount
Type: number or null
Example:
100.0currency_code
Title: ISO currency code
Description: ISO currency code
Type: string or null
Example:
USDchange_reason_code_flag
Title: Change reason code flag
Description: Change reason code flag
Type: string or null
Example:
Yacquirer_ref_num
Title: Acquirer reference number
Description: Acquirer reference number
Type: string or null
Example:
05131054165000000048149chargeback_reason_code
Title: Chargeback reason code for pre-arbitration
Description: Chargeback reason code for pre-arbitration
Type: string or null
Example:
4863currency_code_request
Title: Currency code request for pre-arbitration
Description: Currency code request for pre-arbitration
Type: string or null
Example:
USDcurrency_code_response
Title: Currency code for pre-arbitration
Description: Currency code response for pre-arbitration
Type: string or null
Example:
USDis_partial
Title: Is this a partial pre-arbitration flag
Description: Is this a partial pre-arbitration flag
Type: string or null
Example:
1amount_request
Title: Pre-arbitration amount request
Description: Pre-arbitration amount request
Type: string or null
Example:
3amount_response
Title: Amount response pre_arbitration
Description: Amount response pre_arbitration
Type: string or null
Example:
3.2justify_not_accepted_fully
Title: Not accepted fully justification
Description: Explanation for not accepting full amount
Type: string or null
Example:
Ipsum loren
reversal_reason
Title: Visa network reversal reason
Description: Visa network reversal reason
Type: string or null
Example:
Reason to do a network reversal dispute
transaction_id
Title: Transaction ID
Description: Transaction ID from network
Type: string or null
Example:
null
TI:RL4RGMZY4rIo2Ce2lOa7NGKqasEwvWoxPv04yG2gC4bLQhewMvJL5h2l0PZkx4DHD7JPe03jv5tKR0lFSsIN6PtBbuqtLaQMwOkw64p_xRs=#
account_id
Title: Account ID
Description: Pismo account ID
Type: integer or null
Example:
123456789
authorization_id
Title: Authorization ID
Description: Pismo authorization ID
Type: integer or null
Example:
123456789
internal_transaction_id
Title: Internal transaction ID
Description: Pismo transaction ID
Type: integer or null
Example:
123456789
tracking_id
Title: Tracking ID
Description: Pismo authorization tracking ID
Type: string or null
Example:
null
9cd6485a-5680-4df0-a1f1-507e21d3428c
network_brand_type
Title: Network Brand Type
Description: Network brand
Type: string or null
Example:
null
Mastercard
Visa
Elo
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://example.com/example.json",
"type": "object",
"title": "Dispute installment created",
"description": "This event occurs when a dispute or dispute installment is created. Endpoints that generate this event include <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-networkauthorization-disputes' target='_blank'>Create dispute</a> and <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-disputes-disputeid-installment' target='_blank'>Create dispute installment</a>",
"examples": [
{
"id": 1,
"dispute_id": 2,
"installment": 1,
"arn": "test-arn",
"chargeback_id": null,
"claim_id": null,
"installment_disputed_amount": 150.0,
"network_return_reason_code": null,
"reason_code": 4853,
"network_return_reject_reason": null,
"network_response_error": null,
"is_first_installment": false,
"network_return_reject_reason_code": null,
"dispute_status": {
"id": 4,
"description": "ISSUER_WORKED",
"type": "PRIMITIVE",
"group": "CARDNETWORK_CHARGEBACK"
},
"pre_arb_master": {
"pre_arbitration_response_id": 4,
"memo": "This is a test memo",
"updated_chargeback_reason_code": 2,
"merchant_name": "MERCHANT",
"filing_ica": "001234",
"change_reason_code_reason": "4863",
"case_network_response": "Ok",
"dispute_amount": 100.0,
"currency_code": "USD",
"change_reason_code_flag": "Y",
"acquirer_ref_num": "05131054165000000048149",
"chargeback_reason_code": "4863"
},
"pre_arbitration": {
"pre_arbitration_id": 4,
"memo": "This is a test memo",
"updated_chargeback_reason_code": 2,
"merchant_name": "MERCHANT",
"filing_ica": "001234",
"change_reason_code_reason": "4863",
"network_pre_arbitration_id": "47575939",
"acquirer_memo": "Memo from acquirer",
"case_network_response": "Ok",
"dispute_amount": 100.0,
"change_reason_code_flag": "Y",
"acquirer_ref_num": "05131054165000000048149",
"chargeback_reason_code": "4863",
"currency_code_request": "USD",
"currency_code_response": null,
"is_partial": "1",
"amount_request": "4",
"amount_response": null,
"justify_not_accepted_fully": "1"
},
"chargeback_ref_num": null,
"dispute_due_to": null,
"network_response_amount": 368.5,
"network_response_currency": null,
"network_status": null,
"dispute_form": null,
"dispute_fraud_report": null,
"fraud_type": null,
"reversal_reason": null,
"network_response": [],
"account_id": 123456789,
"authorization_id": 123456789,
"internal_transaction_id": 123456789,
"tracking_id": "9cd6485a-5680-4df0-a1f1-507e21d3428c",
"network_brand_type": "Mastercard"
}
],
"required": [
"arn",
"chargeback_id",
"claim_id",
"dispute_id",
"dispute_status",
"id",
"installment",
"installment_disputed_amount",
"is_first_installment",
"network_return_reason_code",
"network_return_reject_reason",
"network_return_reject_reason_code",
"network_response_error",
"reason_code"
],
"properties": {
"arn": {
"$id": "#/properties/arn",
"type": [
"string",
"null"
],
"title": "ARN",
"description": "ARN - Acquirer reference number",
"examples": [
null,
"test-arn"
]
},
"chargeback_id": {
"$id": "#/properties/chargeback_id",
"type": [
"string",
"null"
],
"title": "Chargeback ID",
"description": "Chargeback ID"
},
"claim_id": {
"$id": "#/properties/claim_id",
"type": [
"string",
"null"
],
"title": "Claim ID",
"description": "Claim ID"
},
"dispute_id": {
"$id": "#/properties/dispute_id",
"type": "integer",
"title": "Dispute ID",
"description": "Dispute ID",
"examples": [
28890
]
},
"dispute_status": {
"$id": "#/properties/dispute_status",
"type": "object",
"title": "Dispute status",
"description": "Dispute status object",
"examples": [
{
"id": 4,
"description": "SECOND_PRESENTMENT",
"type": "PRIMITIVE",
"group": "CARDNETWORK_SECOND_PRESENTMENT"
}
],
"required": [
"description",
"group"
],
"properties": {
"id": {
"$id": "#/properties/dispute_status/properties/id",
"type": [
"integer",
"null"
],
"title": "Dispute status ID",
"description": "Dispute status ID",
"examples": [
4
]
},
"description": {
"$id": "#/properties/dispute_status/properties/description",
"type": "string",
"title": "Dispute status",
"description": "Dispute status enum - depends on state machine. For PRIMITIVE, they are `OPENED PENDING CANCELED FAILED CHARGEBACK_REJECTED CHARGEBACK_CREATED CHARGEBACK_ACCEPTED CHARGEBACK_CLOSED SECOND_PRESENTMENT PRE_ARBITRATION_OPENED PRE_ARBITRATION_ACCEPTED PRE_ARBITRATION_DECLINED PRE_ARBITRATION_RECALL PRE_ARB_ALLOCATION_OPENED FAILED_PRE_ARBITRATION PRE_ARB_ALLOCATION_ACCEPTED PRE_ARB_ALLOCATION_DECLINED PRE_ARB_ALLOCATION_RECALLED FAILED_DECLINE_PRE_ARB FAILED_ACCEPT_PRE_ARB FAILED_ON_CLOSE EXPIRED ISSUER_LOSS`",
"examples": [
"PENDING",
"OPENED"
]
},
"type": {
"$id": "#/properties/dispute_status/properties/type",
"type": "string",
"title": "State machine type",
"description": "Dispute state machine enum",
"enum": [
"MASTERCARD_CARD",
"TOK_PAG",
"PRIMITIVE"
]
},
"group": {
"$id": "#/properties/dispute_status/properties/group",
"type": "string",
"title": "Group dispute status",
"description": "Dispute group statuses",
"enum": [
"OPEN",
"APPROVED",
"DENIED",
"CARDNETWORK_CHARGEBACK",
"ANALYSING",
"CARDNETWORK_SECOND_PRESENTMENT",
"FAILED",
"CARDNETWORK_PREARBITRATION",
"RESEND",
"LOSS",
"WON",
"REJECTED",
"FAILED_PROCESSED"
]
}
},
"additionalProperties": false
},
"id": {
"$id": "#/properties/id",
"type": "integer",
"title": "Installment ID",
"description": "Installment ID",
"examples": [
178500
]
},
"installment": {
"$id": "#/properties/installment",
"type": "integer",
"title": "Installment number",
"description": "Installment index number",
"examples": [
2
]
},
"installment_disputed_amount": {
"$id": "#/properties/installment_disputed_amount",
"type": "number",
"title": "Installment disputed amount",
"description": "Installment disputed amount",
"examples": [
1234.56
]
},
"is_first_installment": {
"$id": "#/properties/is_first_installment",
"type": "boolean",
"title": "First installment flag",
"description": "Is this the first installment flag",
"default": false,
"enum": [
true,
false
]
},
"network_response_error": {
"$id": "#/properties/network_response_error",
"title": "Network response error",
"description": "Network response error",
"type": [
"string",
"null"
],
"examples": [
null,
"The network returned [This field has an invalid input length.], reasonCode [INVALID_INPUT_LENGTH] with the source [acquirerRefNumber]."
]
},
"network_return_reason_code": {
"$id": "#/properties/network_return_reason_code",
"type": [
"string",
"null"
],
"title": "Network return reason code",
"description": "Network return reason code",
"examples": [
null,
"422",
"2002",
"4853",
"CO1"
]
},
"network_return_reject_reason": {
"$id": "#/properties/network_return_reject_reason",
"type": [
"string",
"null"
],
"title": "Network return reject reason",
"description": "Network return reject reason",
"examples": [
"null",
"Code1=0283(00):D0025/000;DE072=D0025\\4837\\\\",
"Code1=2226(00): D0002/000;Code2=0631(00): P0158/004;Code3=2220(00): D0003/000;DE072=D0002\\5214330278318136\\\\P0158\\DE\\\\D0003\\000000\\\\",
"Code1=5001(00): D0025/000;DE072=D0025\\0000\\\\",
"Code1=5000(00): D0025/000;DE072=D0025\\0000\\\\"
]
},
"network_return_reject_reason_code": {
"$id": "#/properties/network_return_reject_reason_code",
"type": [
"integer",
"null"
],
"title": "Network return reject reason code",
"description": "Network return reject reason code",
"examples": [
null,
283,
2226,
5001,
5000
]
},
"reason_code": {
"$id": "#/properties/reason_code",
"type": [
"integer",
"null"
],
"title": "Reason code.",
"description": "Dispute reason code.",
"examples": [
null,
4837,
4850,
4808,
4853
]
},
"category": {
"$id": "#/properties/category",
"type": [
"string",
"null"
],
"title": "Category",
"description": "Category - for ELO card network only",
"enum": [
"INSTALLMENT",
"AIRPORT_TAX"
],
"examples": [
"INSTALLMENT"
]
},
"chargeback_ref_num": {
"$id": "#/properties/chargeback_ref_num",
"type": [
"string",
"null"
],
"title": "Chargeback reference number",
"description": "Chargeback reference number",
"examples": [
"1234"
]
},
"dispute_due_to": {
"$id": "#/properties/dispute_due_to",
"title": "Dispute due to enum",
"description": "Dispute due to enums - VISA, reason code 13. For more details on these enums, see the `dispute_due_to` parameter for the <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-networkauthorization-disputes' target='_blank'>Create dispute</a> endpoint",
"type": [
"string",
"null"
],
"enum": [
"CR",
"ND",
"DM",
"Q",
"CM",
"M",
"CN",
"CS",
"OC",
"CL",
"TC",
"D",
"IAN",
"IA",
"IC",
"IT",
"ID",
"LP",
"P"
]
},
"dispute_form": {
"$id": "#/properties/dispute_form",
"title": "Dispute form object",
"type": [
"object",
"null"
],
"properties": {
"id": {
"title": "Dispute form ID",
"description": "",
"type": [
"integer",
"null"
],
"examples": [
123
]
},
"status": {
"title": "Status",
"description": "",
"type": [
"string",
"null"
],
"enum": [
"PENDING",
"PROCESSED",
"FAILED",
"INACTIVE"
]
},
"network": {
"title": "Network",
"description": "Network state machine",
"type": [
"string",
"null"
],
"enum": [
"MASTERCARD_CARD",
"TOK_PAG",
"PRIMITIVE"
]
},
"form": {
"title": "Form object",
"description": "",
"type": [
"object",
"null"
],
"examples": [
{
"data": "jsonString"
}
]
},
"dispute_installment_id": {
"title": "Dispute installment ID",
"description": "Dispute installment ID",
"type": [
"integer",
"null"
],
"examples": [
123
]
},
"created_at": {
"title": "Created at date/time",
"description": "Created at date/time",
"type": [
"string",
"null"
],
"examples": [
"2022-01-01 11:11:11"
]
},
"created_at_utc": {
"title": "Created at date/time",
"description": "Created at in UTC date/time",
"type": [
"string",
"null"
],
"examples": [
"2022-01-01 10:11:11"
]
},
"updated_at": {
"title": "Updated at date/time",
"description": "Updated at date/time",
"type": "string",
"examples": [
"2022-01-01 22:11:11"
]
},
"updated_at_utc": {
"title": "Updated at in UTC date/time",
"description": "Updated at in UTC date/time",
"type": "string",
"examples": [
"2022-01-01 23:11:11"
]
}
},
"examples": [
{
"id": 123,
"status": "PENDING",
"network": "MASTERCARD_CARD",
"form": {
"data": "jsonString"
},
"dispute_installment_id": 123,
"created_at": "2022-01-01 11:11:11",
"created_at_utc": "2022-01-01 10:11:11",
"updated_at": "2022-01-01 22:11:11",
"updated_at_utc": "2022-01-01 23:11:11"
}
],
"additionalProperties": false
},
"dispute_form_id": {
"$id": "#/properties/dispute_form_id",
"type": [
"string",
"null"
],
"title": "Dispute form ID",
"description": "Dispute form ID",
"examples": [
null,
"283"
]
},
"dispute_fraud_report": {
"$id": "#/properties/dispute_fraud_report",
"title": "Dispute fraud report object",
"description": "",
"type": [
"object",
"null"
],
"properties": {
"fraud_report_id": {
"title": "Fraud report ID",
"description": "",
"type": "integer",
"examples": [
12344
]
},
"status": {
"title": "Status",
"description": "Dispute form status",
"type": [
"string",
"null"
],
"enum": [
"PENDING",
"PROCESSED",
"FAILED",
"INACTIVE"
]
},
"network_brand_type": {
"title": "Network brand",
"description": "Network brand - VISA or Mastercard",
"type": [
"string",
"null"
],
"enum": [
"Mastercard",
"Visa"
]
},
"report": {
"title": "Report object",
"description": "Report object",
"type": [
"object",
"null"
],
"properties": {
"acct_status": {
"title": "Account status",
"description": "Account status enum",
"type": [
"string",
"null"
],
"enum": [
"ACCT_IS_OPEN",
"ACCT_HAS_BEEN_CLOSED"
]
},
"chgbk_indicator": {
"title": "Chargeback indicator",
"description": "Is this a chargeback flag. true = '1', false = '0'",
"type": [
"string",
"null"
],
"examples": [
"1"
]
},
"cvc_invalid_indicator": {
"title": "CVC invalid indicator",
"description": "Mastercard <a href='https://developer.mastercard.com/fld-fraud-submission/documentation/parameters/annexure-1/#table-15-card-validation-code-cvc-indicator' target='_blank'>CVC invalid code indicator</a>",
"type": [
"string",
"null"
],
"examples": [
"1"
]
},
"device_type": {
"title": "Device type ",
"description": "Mastercard <a href='https://developer.mastercard.com/fld-fraud-submission/documentation/parameters/annexure-1/#table-3-account-device-type-codes' target='_blank'>device type</a>",
"type": [
"string",
"null"
],
"examples": [
"K"
]
},
"fraud_type": {
"title": "Fraud type",
"description": "<a href='https://developer.mastercard.com/fld-fraud-submission/documentation/parameters/annexure-1/#table-1-fraud-type-codes' target='_blank'>Fraud type (link)</a>",
"type": [
"string",
"null"
],
"examples": [
"00"
]
},
"report_date": {
"title": "Report date",
"description": "Report date",
"type": [
"string",
"null"
],
"examples": [
"2022-01-01"
]
},
"sub_type": {
"title": "Sub type",
"description": "<a href='https://developer.mastercard.com/fld-fraud-submission/documentation/parameters/annexure-1/#table-2-fraud-sub-type-codes' target='_blank'>Sub type (link)</a>",
"type": [
"string",
"null"
],
"examples": [
"K"
]
}
},
"examples": [
{
"acct_status": "done",
"chgbk_indicator": "1",
"cvc_invalid_indicator": "1",
"device_type": "1",
"fraud_type": "00",
"report_date": "2022-01-01",
"sub_type": "k"
}
]
},
"fraud_report_network_id": {
"title": "Fraud report network ID",
"description": "Fraud report network ID",
"type": "integer",
"examples": [
123
]
},
"created_at": {
"title": "Created at date/time",
"description": "Created at date/time",
"type": [
"string",
"null"
],
"examples": [
"2022-01-01 11:11:11"
]
},
"updated_at": {
"title": "Updated at date/time",
"description": "Updated at date/time",
"type": [
"string",
"null"
],
"examples": [
"2022-01-01 22:11:11"
]
},
"comment_network": {
"title": "Network comment",
"description": "Network comment",
"type": [
"string",
"null"
],
"examples": [
"Comment here"
]
}
},
"examples": [
{
"fraud_report_id": 123,
"status": "PENDING",
"network_brand_type": "Mastercard",
"report": {
"acct_status": "ACCT_IS_OPEN",
"chgbk_indicator": "1",
"cvc_invalid_indicator": "1",
"device_type": "1",
"fraud_type": "00",
"report_date": "2021-02-11",
"sub_type": "K"
},
"fraud_report_network_id": 123,
"created_at": "2022-01-01 11:11:11",
"updated_at": "2022-01-01 22:11:11",
"comment_network": "Comment here"
}
],
"additionalProperties": false
},
"fraud_type": {
"$id": "#/properties/fraud_type",
"title": "Fraud type enum",
"description": "Fraud type enums - VISA, reason code 10",
"type": [
"string",
"null"
],
"enum": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"A",
"B",
"C",
"D"
]
},
"document_indicator": {
"$id": "#/properties/document_indicator",
"type": "boolean",
"title": "Document indicator flag",
"description": "Document submission indicator to Network ELO",
"default": true,
"enum": [
true,
false
]
},
"network_response": {
"$id": "#/properties/network_response",
"title": "Network response object",
"description": "Network response object",
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"title": "ID",
"type": [
"integer",
"null"
],
"default": 0,
"examples": [
123
]
},
"dispute_id": {
"title": "Pismo dispute ID",
"description": "Pismo dispute ID",
"type": [
"integer",
"null"
],
"default": 0,
"examples": [
1234
]
},
"dispute_installment_id": {
"title": "Pismo dispute installment ID",
"description": "Pismo dispute installment ID",
"type": [
"integer",
"null"
],
"default": 0,
"examples": [
4321
]
},
"claim_id": {
"title": "Claim ID",
"description": "Claim ID",
"type": [
"string",
"null"
],
"default": "",
"examples": [
"1345"
]
},
"chargeback_id": {
"title": "Chargeback ID",
"description": "Chargeback ID",
"type": [
"string",
"null"
],
"default": "",
"examples": [
"234aa234jal"
]
},
"reason_code": {
"title": "Reason code.",
"description": "Reason code.",
"type": [
"string",
"null"
],
"default": "",
"examples": [
"4853"
]
},
"response_error": {
"title": "Response error",
"description": "Response error",
"type": [
"string",
"null"
],
"default": "",
"examples": [
"Error created"
]
},
"reject_reason": {
"title": "Reject reason",
"description": "Reject reason",
"type": [
"string",
"null"
],
"default": "",
"examples": [
"123"
]
}
}
}
},
"network_response_amount": {
"$id": "#/properties/network_response_amount",
"type": [
"number",
"null"
],
"title": "Network response amount",
"description": "Network response amount",
"examples": [
1234
]
},
"network_response_currency": {
"$id": "#/properties/network_response_currency",
"title": "Network response currency",
"description": "Network response currency code",
"type": [
"string",
"null"
],
"examples": [
"USD",
"BRL"
]
},
"network_status": {
"$id": "#/properties/network_status",
"title": "Dispute network status",
"description": "Dispute network status",
"type": [
"string",
"null"
],
"examples": [
"Authorization Dispute - Accepted by Acq"
]
},
"pre_arb_master": {
"$id": "#/properties/pre_arb_master",
"type": [
"object",
"null"
],
"title": "Pre-abitration for Mastercard object",
"examples": [
{
"pre_arbitration_response_id": 4,
"memo": "This is a test memo",
"updated_chargeback_reason_code": 2,
"merchant_name": "MERCHANT",
"filing_ica": "001234",
"change_reason_code_reason": "4863",
"case_network_response": "Ok",
"dispute_amount": 100.0,
"currency_code": "USD",
"change_reason_code_flag": "Y",
"acquirer_ref_num": "05131054165000000048149",
"chargeback_reason_code": "4863"
}
],
"properties": {
"pre_arbitration_response_id": {
"$id": "#/properties/pre_arb_master/properties/pre_arbitration_response_id",
"type": [
"integer",
"null"
],
"title": "Pre arbitration response ID",
"description": "Pre arbitration response ID",
"examples": [
4
]
},
"memo": {
"$id": "#/properties/pre_arb_master/properties/memo",
"type": [
"string",
"null"
],
"title": "Pre-arb memo",
"description": "Pre-arbitration memo",
"examples": [
"Who uses memos anymore"
]
},
"updated_chargeback_reason_code": {
"$id": "#/properties/pre_arb_master/properties/updated_chargeback_reason_code",
"type": [
"integer",
"null"
],
"title": "Updated chargeback reason code",
"description": "Updated chargeback reason code",
"examples": [
2
]
},
"merchant_name": {
"$id": "#/properties/pre_arb_master/properties/merchant_name",
"type": [
"string",
"null"
],
"title": "Merchant name",
"description": "Merchant name",
"examples": [
"Acme Goods"
]
},
"filing_ica": {
"$id": "#/properties/pre_arb_master/properties/filing_ica",
"type": [
"string",
"null"
],
"title": "ICA filing",
"description": "ICA filing",
"examples": [
"001234"
]
},
"change_reason_code_reason": {
"$id": "#/properties/pre_arb_master/properties/change_reason_code_reason",
"type": [
"string",
"null"
],
"title": "Change reason code reason",
"description": "Change reason code reason",
"examples": [
"Explanation for reason code change"
]
},
"case_network_response": {
"$id": "#/properties/pre_arb_master/properties/case_network_response",
"type": [
"string",
"null"
],
"title": "Case network response",
"description": "Case network response",
"examples": [
"Ok"
]
},
"dispute_amount": {
"$id": "#/properties/pre_arb_master/properties/dispute_amount",
"type": [
"number",
"null"
],
"title": "Dispute amount",
"description": "Dispute amount",
"examples": [
"100.0"
]
},
"currency_code": {
"$id": "#/properties/pre_arb_master/properties/currency_code",
"type": [
"string",
"null"
],
"title": "Currency code",
"description": "ISO currency code",
"examples": [
"USD"
]
},
"change_reason_code_flag": {
"$id": "#/properties/pre_arb_master/properties/change_reason_code_flag",
"type": [
"string",
"null"
],
"title": "Change reason code flag",
"description": "Change reason code flag",
"examples": [
"Y"
]
},
"acquirer_ref_num": {
"$id": "#/properties/pre_arb_master/properties/acquirer_ref_num",
"type": [
"string",
"null"
],
"title": "Acquirer reference number",
"description": "Acquirer reference number",
"examples": [
"05131054165000000048149"
]
},
"chargeback_reason_code": {
"$id": "#/properties/pre_arb_master/properties/chargeback_reason_code",
"type": [
"string",
"null"
],
"title": "The chargeback_reason_code pre_arb_master schema",
"examples": [
"4863"
]
}
}
},
"pre_arbitration": {
"$id": "#/properties/pre_arbitration",
"type": [
"object",
"null"
],
"title": "Pre-arbitration object",
"description": "Pre-arbitration object",
"examples": [
{
"pre_arbitration_id": 4,
"memo": "This is a test memo",
"acquirer_memo": "Memo from acquirer",
"updated_chargeback_reason_code": 2,
"merchant_name": "MERCHANT",
"filing_ica": "001234",
"change_reason_code_reason": "4863",
"case_network_response": "Ok",
"dispute_amount": 100.0,
"change_reason_code_flag": "Y",
"acquirer_ref_num": "05131054165000000048149",
"network_pre_arbitration_id": "8484999587",
"chargeback_reason_code": "4863",
"currency_code_response": null,
"currency_code_request": null,
"is_partial": "1",
"amount_request": "4",
"amount_response": null,
"justify_not_accepted_fully": "1"
}
],
"properties": {
"pre_arbitration_id": {
"$id": "#/properties/pre_arbitration/properties/pre_arbitration_id",
"type": [
"integer",
"null"
],
"title": "Pre arbitration ID",
"description": "Pre arbitration ID",
"examples": [
49975
]
},
"acquirer_memo": {
"$id": "#/properties/acquirer_memo",
"type": [
"string",
"null"
],
"title": "Acquirer memo",
"description": "Acquirer memo",
"examples": [
null,
"Memo from acquirer about this dispute"
]
},
"memo": {
"$id": "#/properties/pre_arbitration/properties/memo",
"type": [
"string",
"null"
],
"title": "Pre-arbitration memo",
"description": "Pre-arbitration memo",
"examples": [
"Who uses memos anymore"
]
},
"network_pre_arbitration_id": {
"$id": "#/properties/network_pre_arbitration_id",
"title": "Network pre-arbitration ID",
"description": "Network created pre-arbitration ID",
"type": [
"string",
"null"
],
"examples": [
null,
"6789033989"
]
},
"updated_chargeback_reason_code": {
"$id": "#/properties/pre_arbitration/properties/updated_chargeback_reason_code",
"type": [
"integer",
"null"
],
"title": "Updated chargeback reason code",
"description": "Updated chargeback reason code",
"examples": [
2
]
},
"merchant_name": {
"$id": "#/properties/pre_arbitration/properties/merchant_name",
"type": [
"string",
"null"
],
"title": "Merchant name",
"description": "Merchant name",
"examples": [
"Acme Goods"
]
},
"filing_ica": {
"$id": "#/properties/pre_arbitration/properties/filing_ica",
"type": [
"string",
"null"
],
"title": "ICA filing",
"description": "ICA filing",
"examples": [
"001234"
]
},
"change_reason_code_reason": {
"$id": "#/properties/pre_arbitration/properties/change_reason_code_reason",
"type": [
"string",
"null"
],
"title": "Change reason code reason",
"description": "Change reason code reason",
"examples": [
"4863"
]
},
"case_network_response": {
"$id": "#/properties/pre_arbitration/properties/case_network_response",
"type": [
"string",
"null"
],
"title": "Case network response",
"description": "Case network response",
"examples": [
"Ok"
]
},
"dispute_amount": {
"$id": "#/properties/pre_arbitration/properties/dispute_amount",
"type": [
"number",
"null"
],
"title": "Dispute amount",
"description": "Dispute amount",
"examples": [
"100.0"
]
},
"currency_code": {
"$id": "#/properties/pre_arbitration/properties/currency_code",
"type": [
"string",
"null"
],
"title": "ISO currency code",
"description": "ISO currency code",
"examples": [
"USD"
]
},
"change_reason_code_flag": {
"$id": "#/properties/pre_arbitration/properties/change_reason_code_flag",
"type": [
"string",
"null"
],
"title": "Change reason code flag",
"description": "Change reason code flag",
"examples": [
"Y"
]
},
"acquirer_ref_num": {
"$id": "#/properties/pre_arbitration/properties/acquirer_ref_num",
"type": [
"string",
"null"
],
"title": "Acquirer reference number",
"description": "Acquirer reference number",
"examples": [
"05131054165000000048149"
]
},
"chargeback_reason_code": {
"$id": "#/properties/pre_arbitration/properties/chargeback_reason_code",
"type": [
"string",
"null"
],
"title": "Chargeback reason code for pre-arbitration",
"description": "Chargeback reason code for pre-arbitration",
"examples": [
"4863"
]
},
"currency_code_request": {
"$id": "#/properties/pre_arbitration/properties/currency_code_request",
"type": [
"string",
"null"
],
"title": "Currency code request for pre-arbitration",
"description": "Currency code request for pre-arbitration",
"examples": [
"USD"
]
},
"currency_code_response": {
"$id": "#/properties/pre_arbitration/properties/currency_code_response",
"type": [
"string",
"null"
],
"title": "Currency code for pre-arbitration",
"description": "Currency code response for pre-arbitration",
"examples": [
"USD"
]
},
"is_partial": {
"$id": "#/properties/pre_arbitration/properties/is_partial",
"type": [
"string",
"null"
],
"title": "Is this a partial pre-arbitration flag",
"description": "Is this a partial pre-arbitration flag",
"examples": [
"1"
]
},
"amount_request": {
"$id": "#/properties/pre_arbitration/properties/amount_request",
"type": [
"string",
"null"
],
"title": "Pre-arbitration amount request",
"description": "Pre-arbitration amount request",
"examples": [
"3"
]
},
"amount_response": {
"$id": "#/properties/pre_arbitration/properties/amount_response",
"type": [
"string",
"null"
],
"title": "Amount response pre_arbitration",
"description": "Amount response pre_arbitration",
"examples": [
"3.2"
]
},
"justify_not_accepted_fully": {
"$id": "#/properties/pre_arbitration/properties/justify_not_accepted_fully",
"type": [
"string",
"null"
],
"title": "Not accepted fully justification",
"description": "Explanation for not accepting full amount",
"examples": [
"Ipsum loren"
]
}
},
"additionalProperties": false
},
"reversal_reason": {
"$id": "#/properties/reversal_reason",
"title": "Visa network reversal reason",
"description": "Visa network reversal reason",
"type": [
"string",
"null"
],
"examples": [
"Reason to do a network reversal dispute"
]
},
"transaction_id": {
"$id": "#/properties/transaction_id",
"type": [
"string",
"null"
],
"title": "Transaction ID",
"description": "Transaction ID from network",
"examples": [
null,
"TI:RL4RGMZY4rIo2Ce2lOa7NGKqasEwvWoxPv04yG2gC4bLQhewMvJL5h2l0PZkx4DHD7JPe03jv5tKR0lFSsIN6PtBbuqtLaQMwOkw64p_xRs=#"
]
},
"account_id": {
"$id": "#/properties/account_id",
"type": [
"integer",
"null"
],
"title": "Account ID",
"description": "Pismo account ID",
"examples": [
123456789
]
},
"authorization_id": {
"$id": "#/properties/authorization_id",
"type": [
"integer",
"null"
],
"title": "Authorization ID",
"description": "Pismo authorization ID",
"examples": [
123456789
]
},
"internal_transaction_id": {
"$id": "#/properties/internal_transaction_id",
"type": [
"integer",
"null"
],
"title": "Internal transaction ID",
"description": "Pismo transaction ID",
"examples": [
123456789
]
},
"tracking_id": {
"$id": "#/properties/tracking_id",
"type": [
"string",
"null"
],
"title": "Tracking ID",
"description": "Pismo authorization tracking ID",
"examples": [
null,
"9cd6485a-5680-4df0-a1f1-507e21d3428c"
]
},
"network_brand_type": {
"$id": "#/properties/network_brand_type",
"type": [
"string",
"null"
],
"title": "Network Brand Type",
"description": "Network brand",
"examples": [
null,
"Mastercard",
"Visa",
"Elo"
]
}
},
"additionalProperties": false
}
Updated 24 days ago