curl --request POST \
--url https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--form providerReasonCode=service_provided \
--form provenance=Merchant \
--form 'files[][0]={
"filename": [
"evidence_invoice.pdf",
"delivery_note.jpg"
]
}' \
--form 'files[][1]={
"filename": [
"evidence_reason.pdf",
"reason_note.jpg"
]
}' \
--form 'providerEvidenceTypeCodes[0]=Invoice' \
--form 'providerEvidenceTypeCodes[1]=DefenseMaterial'import requests
url = "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--"
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('providerReasonCode', 'service_provided');
form.append('provenance', 'Merchant');
form.append('files[][0]', '{
"filename": [
"evidence_invoice.pdf",
"delivery_note.jpg"
]
}');
form.append('files[][1]', '{
"filename": [
"evidence_reason.pdf",
"reason_note.jpg"
]
}');
form.append('providerEvidenceTypeCodes[0]', 'Invoice');
form.append('providerEvidenceTypeCodes[1]', 'DefenseMaterial');
const options = {
method: 'POST',
headers: {'x-idempotency-key': '<x-idempotency-key>', Authorization: 'Bearer <token>'}
};
options.body = form;
fetch('https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerReference": "<string>",
"stage": "Created",
"amount": {
"value": "12.50",
"currency": "EUR"
},
"applicableDefenseReasons": [
{
"providerReasonCode": "<string>",
"evidenceTypes": [
{
"providerTypeCode": "<string>"
}
]
}
],
"assignedToUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedToUserEmail": "<string>",
"channel": "Provider",
"chargebackStatus": "Incoming",
"defenseStatus": "NotDefendable",
"defensePeriodExpiresAt": "2023-11-07T05:31:56Z",
"providerCreatedAt": "2023-11-07T05:31:56Z",
"merchantReference": "<string>",
"paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"executionId": "<string>",
"reason": "<string>",
"reasonCode": "<string>",
"schemeReasonCode": "<string>",
"issuerComments": {},
"liabilityShifted": true,
"payment": {
"status": "Created",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"providerDisplayName": "<string>",
"providerReference": "<string>",
"providerConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerIntegrationType": "<string>",
"paymentMethodType": "<string>",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"holderReference": "<string>",
"amount": {
"value": "12.50",
"currency": "EUR"
},
"merchantReference": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instrument": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": "alexBankMa7fazty",
"status": "created",
"displayName": "<string>",
"description": "<string>",
"default": true,
"merchantReference": "<string>",
"fingerprint": "<string>",
"futureUsage": "Subscription",
"networkTransactionReference": "<string>",
"transactionLinkId": "<string>",
"data": {
"network": "unspecified",
"bin": "416598",
"suffix": "<string>",
"preferredScheme": "unspecified",
"binLookup": {
"bin": "416598",
"network": "unspecified",
"localNetwork": "bancontact",
"issuer": "<string>",
"issuerCountry": {
"code": "<string>",
"iso3": "<string>",
"name": "<string>"
},
"segment": "<string>",
"type": "<string>",
"typeDetails": "<string>",
"isNetworkToken": true,
"isFlexCard": true
},
"billingAddress": {
"street": "<string>",
"doorNumber": "<string>",
"complement": "<string>",
"area": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"country": {
"code": "<string>",
"iso3": "<string>",
"name": "<string>"
},
"latitude": 123,
"longitude": 123,
"phone": {
"number": "<string>",
"countryCode": "<string>"
},
"alias": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
},
"expiryMonth": "<string>",
"expiryYear": "<string>",
"holderName": "<string>",
"taxId": "<string>"
}
},
"meta": {
"order": {},
"customer": {},
"clientContext": {},
"vendor": {},
"risk": {},
"subscription": {},
"tags": {},
"paymentMethods": {},
"upi": "<unknown>"
}
},
"evidences": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"displayTitle": "<string>",
"status": "Active",
"provenance": "Merchant",
"contentType": "<string>",
"contentLength": 123,
"payload": {},
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"validFrom": "2023-11-07T05:31:56Z",
"changeNote": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"labels": [
"<string>"
]
}
],
"representmentPlan": {
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "GeneratingPlan",
"providerResponseId": "<string>",
"lastSectionGeneration": {
"succeeded": true,
"completedAt": "2023-11-07T05:31:56Z"
},
"recommendation": "<string>",
"rationale": "<string>",
"defenseReasons": [
{
"code": "<string>",
"title": "<string>",
"description": "<string>",
"selected": true,
"options": [
{
"position": 123,
"title": "<string>",
"description": "<string>",
"required": true,
"slug": "<string>",
"evidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evidenceInfo": {
"displayTitle": "<string>",
"contentType": "<string>",
"contentLength": 123
}
}
]
}
]
},
"representmentSections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"position": 123,
"indent": 123,
"sectionType": "Text",
"textSectionTitle": "<string>",
"textSectionContent": "<string>",
"textSectionEvidenceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pictureSectionEvidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pictureSectionLabel": "<string>",
"pictureSectionEvidenceLinks": {
"download": "<string>"
}
}
],
"representmentPlanStatus": "GeneratingPlan",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"color": "<string>",
"type": "<string>",
"typeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardinality": "single",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"evidenceClassifications": [
{
"evidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "classifying",
"contentSummary": "<string>",
"documentType": "<string>",
"provesStatement": "<string>",
"keyFacts": [
"<string>"
],
"suggestedPlanMatches": [
{
"defenseReasonCode": "<string>",
"slug": "<string>",
"position": 123,
"rationale": "<string>"
}
],
"providerResponseId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.malformed",
"detail": "The request has malformed syntax",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestmalformed"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.unauthorized",
"detail": "The request lacks necessary credentials to perform the specified action",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"
}
]
}{
"errors": [
{
"id": "e7db22b3-914e-4975-928e-9edfb0885bea",
"code": "request.forbidden",
"detail": "The request credentials lack the required permissions to perform the specified action",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestforbidden"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.not-found",
"detail": "The requested resource was not found",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestnot-found"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.conflict",
"detail": "The request operation is not allowed due to a conflict with the current state of the resource",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestconflict"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.rate-limit",
"detail": "Too many requests",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "internal",
"detail": "An internal error occurred",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#internal"
}
]
}Defend a Dispute
Defend a dispute by sending evidence files, a type code per file, and a provider reason code to the payment provider, and get the updated dispute.
curl --request POST \
--url https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--form providerReasonCode=service_provided \
--form provenance=Merchant \
--form 'files[][0]={
"filename": [
"evidence_invoice.pdf",
"delivery_note.jpg"
]
}' \
--form 'files[][1]={
"filename": [
"evidence_reason.pdf",
"reason_note.jpg"
]
}' \
--form 'providerEvidenceTypeCodes[0]=Invoice' \
--form 'providerEvidenceTypeCodes[1]=DefenseMaterial'import requests
url = "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--"
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('providerReasonCode', 'service_provided');
form.append('provenance', 'Merchant');
form.append('files[][0]', '{
"filename": [
"evidence_invoice.pdf",
"delivery_note.jpg"
]
}');
form.append('files[][1]', '{
"filename": [
"evidence_reason.pdf",
"reason_note.jpg"
]
}');
form.append('providerEvidenceTypeCodes[0]', 'Invoice');
form.append('providerEvidenceTypeCodes[1]', 'DefenseMaterial');
const options = {
method: 'POST',
headers: {'x-idempotency-key': '<x-idempotency-key>', Authorization: 'Bearer <token>'}
};
options.body = form;
fetch('https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data",
"x-idempotency-key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.staging.payrails.io/dispute/disputes/{disputeId}/defend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerReasonCode\"\r\n\r\nservice_provided\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"provenance\"\r\n\r\nMerchant\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B0%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_invoice.pdf\",\r\n \"delivery_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files%5B%5D%5B1%5D\"\r\n\r\n{\r\n \"filename\": [\r\n \"evidence_reason.pdf\",\r\n \"reason_note.jpg\"\r\n ]\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B0%5D\"\r\n\r\nInvoice\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"providerEvidenceTypeCodes%5B1%5D\"\r\n\r\nDefenseMaterial\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerReference": "<string>",
"stage": "Created",
"amount": {
"value": "12.50",
"currency": "EUR"
},
"applicableDefenseReasons": [
{
"providerReasonCode": "<string>",
"evidenceTypes": [
{
"providerTypeCode": "<string>"
}
]
}
],
"assignedToUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedToUserEmail": "<string>",
"channel": "Provider",
"chargebackStatus": "Incoming",
"defenseStatus": "NotDefendable",
"defensePeriodExpiresAt": "2023-11-07T05:31:56Z",
"providerCreatedAt": "2023-11-07T05:31:56Z",
"merchantReference": "<string>",
"paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"executionId": "<string>",
"reason": "<string>",
"reasonCode": "<string>",
"schemeReasonCode": "<string>",
"issuerComments": {},
"liabilityShifted": true,
"payment": {
"status": "Created",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerName": "<string>",
"providerDisplayName": "<string>",
"providerReference": "<string>",
"providerConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"providerIntegrationType": "<string>",
"paymentMethodType": "<string>",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"holderReference": "<string>",
"amount": {
"value": "12.50",
"currency": "EUR"
},
"merchantReference": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instrument": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": "alexBankMa7fazty",
"status": "created",
"displayName": "<string>",
"description": "<string>",
"default": true,
"merchantReference": "<string>",
"fingerprint": "<string>",
"futureUsage": "Subscription",
"networkTransactionReference": "<string>",
"transactionLinkId": "<string>",
"data": {
"network": "unspecified",
"bin": "416598",
"suffix": "<string>",
"preferredScheme": "unspecified",
"binLookup": {
"bin": "416598",
"network": "unspecified",
"localNetwork": "bancontact",
"issuer": "<string>",
"issuerCountry": {
"code": "<string>",
"iso3": "<string>",
"name": "<string>"
},
"segment": "<string>",
"type": "<string>",
"typeDetails": "<string>",
"isNetworkToken": true,
"isFlexCard": true
},
"billingAddress": {
"street": "<string>",
"doorNumber": "<string>",
"complement": "<string>",
"area": "<string>",
"city": "<string>",
"postalCode": "<string>",
"state": "<string>",
"country": {
"code": "<string>",
"iso3": "<string>",
"name": "<string>"
},
"latitude": 123,
"longitude": 123,
"phone": {
"number": "<string>",
"countryCode": "<string>"
},
"alias": "<string>",
"name": "<string>",
"lastName": "<string>",
"email": "<string>"
},
"expiryMonth": "<string>",
"expiryYear": "<string>",
"holderName": "<string>",
"taxId": "<string>"
}
},
"meta": {
"order": {},
"customer": {},
"clientContext": {},
"vendor": {},
"risk": {},
"subscription": {},
"tags": {},
"paymentMethods": {},
"upi": "<unknown>"
}
},
"evidences": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"displayTitle": "<string>",
"status": "Active",
"provenance": "Merchant",
"contentType": "<string>",
"contentLength": 123,
"payload": {},
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"validFrom": "2023-11-07T05:31:56Z",
"changeNote": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"labels": [
"<string>"
]
}
],
"representmentPlan": {
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "GeneratingPlan",
"providerResponseId": "<string>",
"lastSectionGeneration": {
"succeeded": true,
"completedAt": "2023-11-07T05:31:56Z"
},
"recommendation": "<string>",
"rationale": "<string>",
"defenseReasons": [
{
"code": "<string>",
"title": "<string>",
"description": "<string>",
"selected": true,
"options": [
{
"position": 123,
"title": "<string>",
"description": "<string>",
"required": true,
"slug": "<string>",
"evidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evidenceInfo": {
"displayTitle": "<string>",
"contentType": "<string>",
"contentLength": 123
}
}
]
}
]
},
"representmentSections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"position": 123,
"indent": 123,
"sectionType": "Text",
"textSectionTitle": "<string>",
"textSectionContent": "<string>",
"textSectionEvidenceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pictureSectionEvidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pictureSectionLabel": "<string>",
"pictureSectionEvidenceLinks": {
"download": "<string>"
}
}
],
"representmentPlanStatus": "GeneratingPlan",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"color": "<string>",
"type": "<string>",
"typeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cardinality": "single",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"evidenceClassifications": [
{
"evidenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"disputeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "classifying",
"contentSummary": "<string>",
"documentType": "<string>",
"provesStatement": "<string>",
"keyFacts": [
"<string>"
],
"suggestedPlanMatches": [
{
"defenseReasonCode": "<string>",
"slug": "<string>",
"position": 123,
"rationale": "<string>"
}
],
"providerResponseId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.malformed",
"detail": "The request has malformed syntax",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestmalformed"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.unauthorized",
"detail": "The request lacks necessary credentials to perform the specified action",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"
}
]
}{
"errors": [
{
"id": "e7db22b3-914e-4975-928e-9edfb0885bea",
"code": "request.forbidden",
"detail": "The request credentials lack the required permissions to perform the specified action",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestforbidden"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.not-found",
"detail": "The requested resource was not found",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestnot-found"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.conflict",
"detail": "The request operation is not allowed due to a conflict with the current state of the resource",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestconflict"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "request.rate-limit",
"detail": "Too many requests",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestrate-limit"
}
]
}{
"errors": [
{
"id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
"code": "internal",
"detail": "An internal error occurred",
"docUrl": "https://docs.payrails.com/docs/resources/error-codes#internal"
}
]
}Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Headers
Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.
Path Parameters
Identifier of the resource in Payrails.
Body
Provider-specific reason code for the defense.
Provenance of the dispute evidence.
Merchant, Payrails, Unknown List of files supporting the dispute defense.
List of type codes for each file entry on files parameter.
Response
Defense submitted and dispute updated.
Unique identifier of the Dispute in Payrails.
Date and time when the Dispute was created in Payrails.
Date and time when the Dispute was last updated in Payrails.
Unique identifier of the Provider that was used to process the Dispute.
Unique identifier of the merchant-specific Provider Configuration that was used to process the Dispute. This can include the set of credentials used, the merchant account, country, vertical, etc.
Unique identifier of the Dispute in the Provider.
Stage of the dispute.
Created, FraudReport, Retrieval, Chargeback, PreArbitration, Arbitration, Unknown Amount of the Dispute. May differ from amount of Payment.
List of reasons codes used when defending a Dispute.
Hide child attributes
Hide child attributes
Email of the user currently assigned to this dispute. Only present when includeUserEmail=true and a user is assigned.
Channel the customer used to raise the dispute.
Not every provider reports a channel, and the field is only populated on
disputes received after it was introduced. It is therefore absent on many
disputes, and absence says nothing about how the dispute was raised — do not
read a missing channel as the absence of an issuer chargeback.
Provider: the customer raised the dispute with the payment provider directly, without involving their bank.Issuer: the customer went to their card issuer or bank, so the dispute is a card chargeback.Alert: the dispute arrived as a pre-chargeback alert, and no chargeback has been raised yet.Unknown: the Provider reported a channel that Payrails does not recognize.
Provider, Issuer, Alert, Unknown Status of the chargeback.
Incoming, Executed, Reversed, SecondChargeback, IssuerReponseTimeframeExpired, ArbitrationReversed Status of the defense.
NotDefendable, Undefended, ReadyToSubmit, Submitted, Failed, UnderReview, Won, Lost, Accepted, Resolved, Unknown Date and time when the Dispute defense period expires.
Date and time when the Dispute was created in the Provider. Only present if informed by Provider.
Merchant-supplied reference for the payment that originated the Dispute (e.g. an order ID). Populated from the PSP notification for Adyen, PayPal, and Checkout.com disputes, or from the linked Payment for other providers. Omitted when not available.
Unique identifier in Payrails of the Payment that originated the Dispute. Only available if the Payment was created via Payrails. When handling Disputes related to Payments created outside Payrails, this field will be omitted.
Workspace ID that the Dispute belongs to.
Unique identifier of the workflow execution that manages this Dispute's lifecycle in Payrails. Present once the dispute-management workflow has been started for the Dispute; omitted otherwise.
Human-readable description of why the dispute was raised.
Provider-specific reason code for the dispute, when supplied by the Provider.
Card-scheme reason code for the dispute, when supplied by the Provider.
Indicates whether liability has shifted away from the merchant, as determined by the Provider or by 3DS authentication data. When true, the issuer bears the chargeback liability. Null if not yet determined.
Hide child attributes
Hide child attributes
Unique identifier of the Payment in Payrails. Omitted for Disputes on Payments that were not created via Payrails.
Exact date and time when the Payment was created. Possibly differs slightly from the date in the PSP.
Unique identifier of the Provider that was used to process the Payment.
Name of the Provider that was used to process the Payment, e.g. Adyen, Checkout, Stripe.
Display name of the Provider that was used to process the Payment.
Unique identifier of the Payment in an external system, e.g. PSP.
Unique identifier of the merchant-specific Provider Configuration that was used to process the Payment. This can include the set of credentials used, the merchant account, country, vertical, etc.
Type of integration used to process the payment (in case the payment provider supports multiple).
Type of payment method used to process the payment.
Unique identifier of the Holder that is involved in the Payment.
Merchant-provided reference of the Holder involved in the Payment.
Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.
Workspace ID that the Payment belongs to.
Optionally included details about the instrument used for the payment.
Hide child attributes
Hide child attributes
Id of the instrument.
Date and time when the Instrument was created in Payrails.
When the Instrument was last updated.
Unique identifier of the Holder in Payrails.
Represents the payment method type.
alexBankMa7fazty, applePay, audi2pay, bankAccount, card, 2c2p, vietQR, cibSmartWallet, easypaisa, etisalatCash, fawryMobileWallet, fawryPay, googlePay, jazzCash, nbePhoneCash, orangeCash, payPal, qnbEWallet, weCash, genericRedirect, alfa, konnect, eftPro, netBanking, upi, upiDirect, cashFreeWallet, paytmWallet, phonePe, iDeal, iDealDirect, bancontact, mbWay, mbWayDirect, sepaDirectDebit, sepaDirectDebitDirect, klarnaPayLater, klarnaPayNow, klarnaPayOverTime, scalapay, payNow, atome, fpx, swish Status of the instrument.
created, deleted, enabled, disabled, transient Instrument name suitable for display.
Description of the instrument.
True if this instrument is set as default for the holder.
Merchant-provided reference for the instrument.
System-wide unique identifier of the Instrument. If two Holders have the same instrument stored, this value will be the same for both, but the instrument and token IDs will be different. Cannot be used for payments, should only be used for analytics and fraud prevention.
Represents the future usage to define the payment flows that the stored instrument will be used for.
Subscription, CardOnFile, UnscheduledCardOnFile Identifier of the initial payment made with this instrument on the Networks, e.g. Mastercard Trace ID or Visa Transaction ID.
Mastercard Transaction Link Identifier (TLID) of the transaction series this instrument belongs to. Returned by the card network on the initial cardholder-initiated transaction and required on economically related merchant-initiated transactions, such as recurring payments and installments, when the series spans payment providers.
Type-specific information about the instrument.
- Card
- BankAccount
- PayPal
- GooglePay
- ApplePay
- DCB
- MBWayDirect
Hide child attributes
Hide child attributes
Network of the instrument.
unspecified, visa, visadankort, mastercard, amex, diners, discover, unionpay, unionpayuzcard, maestro, maestrobancontact, hipercard, jcb, jcblankapay, argencard, aura, belkart, bpfuelcard, cabal, carnet, cirrus, chjonesfuelcard, uzcard, codensa, dankort, dinacard, duet, ebt, eftpos, elo, euroshellfuelcard, gecapital, bc, hrgstore, humo, lankapay, lukoilfuelcard, bancontact, meeza, newday, mir, ourocard, pagobancomat, paypak, paypal, phhfuelcard, prostir, rupay, sbercard, sodexo, starrewards, cencosud, naranja, troy, uatp, ukfuelcard, verve, voyager, vpay, wex, cmi, atm, bankcard, localbrand, loyalty, privatelabel, fuelcard, redfuelcard, redliquidfuelcard First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).
6 - 8"416598"
Last digits of the Card number.
4Network of the instrument.
unspecified, visa, visadankort, mastercard, amex, diners, discover, unionpay, unionpayuzcard, maestro, maestrobancontact, hipercard, jcb, jcblankapay, argencard, aura, belkart, bpfuelcard, cabal, carnet, cirrus, chjonesfuelcard, uzcard, codensa, dankort, dinacard, duet, ebt, eftpos, elo, euroshellfuelcard, gecapital, bc, hrgstore, humo, lankapay, lukoilfuelcard, bancontact, meeza, newday, mir, ourocard, pagobancomat, paypak, paypal, phhfuelcard, prostir, rupay, sbercard, sodexo, starrewards, cencosud, naranja, troy, uatp, ukfuelcard, verve, voyager, vpay, wex, cmi, atm, bankcard, localbrand, loyalty, privatelabel, fuelcard, redfuelcard, redliquidfuelcard Information about an issuer by the given BIN (or IIN).
Hide child attributes
Hide child attributes
First 6-8 digits of the Card number. Also known as IIN (Issuer Identification Number).
6 - 8"416598"
Network of the instrument.
unspecified, visa, visadankort, mastercard, amex, diners, discover, unionpay, unionpayuzcard, maestro, maestrobancontact, hipercard, jcb, jcblankapay, argencard, aura, belkart, bpfuelcard, cabal, carnet, cirrus, chjonesfuelcard, uzcard, codensa, dankort, dinacard, duet, ebt, eftpos, elo, euroshellfuelcard, gecapital, bc, hrgstore, humo, lankapay, lukoilfuelcard, bancontact, meeza, newday, mir, ourocard, pagobancomat, paypak, paypal, phhfuelcard, prostir, rupay, sbercard, sodexo, starrewards, cencosud, naranja, troy, uatp, ukfuelcard, verve, voyager, vpay, wex, cmi, atm, bankcard, localbrand, loyalty, privatelabel, fuelcard, redfuelcard, redliquidfuelcard Card local network that supports the card, e.g. CartesBancaires, Dankort, Mada, Bancontact.
bancontact, cartesbancaires, dankort, mada Name of the bank or institution that issued the card.
Country of the bank or institution that issued the card.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
Segment of the card, e.g. gold, black, business.
Type of the card, e.g. credit, debit, prepaid, gift.
More information about the card type, e.g. personal, commercial.
Indicates whether the card credential represents a network token rather than a primary account number (PAN).
Indicates whether the card is enrolled in a Flexible Credential or Flex Card program supported by the network - e.g. Visa Flexible Credential, Mastercard FlexCard.
Billing Address of the instrument.
Hide child attributes
Hide child attributes
The name of the street of a postal address.
The number on the door, building, or room.
Additional addressing information, 2nd line of postal address.
The name of the suburb or area within a city.
The name of the city of a postal address.
The postal code.
The name of the state a postal address is in.
The country where the address is in.
Hide child attributes
Hide child attributes
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$ISO 3-letter country code. Returned by Payrails, but not interpreted in requests.
^[A-Z]{3}$The English name of the country. Returned by Payrails, but not interpreted in requests.
Latitude of the address in the GPS coordinate system.
Longitude of the address in the GPS coordinate system.
The phone to contact in the address (can be different that the customer's).
Hide child attributes
Hide child attributes
The local number of the phone, such that countryCode + number can be dialed.
^[0-9]+$International prefix of the phone, if known separately.
^\+?[0-9]+$Name of the address, e.g. home, work.
Name of the person to whom the address belongs to.
Last name of the person to whom the address belongs to.
Email of the person to whom the address belongs to.
Expiry month of the Card.
2Expiry year of the Card.
4Name of the owner of the Card.
Payer-provided tax identification number (e.g. CPF in Brazil) collected on the instrument.
Metadata for the context of an execution. Includes Payrails-defined structures for most common fields used in workflows, but can also be extended by merchant or provider-specific fields. For more information, visit our Meta Fields guide. See Meta for every field.
Hide child attributes
Hide child attributes
The order being placed on your system. See Meta.order for every field.
The customer placing the order. See Meta.customer for every field.
Data describing the customer's device or browser. See Meta.clientContext for every field.
Description of a vendor that provides the order. See Meta.vendor for every field.
Configuration of a subscription process. See Meta.subscription for every field.
Additional meta fields to be sent to the payment providers which support metadata / tags. For example, sent to Stripe as metadata. Because these will always be PSP-specific, we do NOT recommend using these fields if they can actually be mapped to a generic field above.
Per-payment-method shopper input, namespaced by payment method code so each method's fields stay isolated. Only the entry matching the payment method being charged is read. See Meta.paymentMethods for every field.
List of evidences associated with this dispute.
Hide child attributes
Hide child attributes
Unique identifier of the Dispute in Payrails.
Date and time when the Dispute was created in Payrails.
Date and time when the Dispute was last updated in Payrails.
Display title of the evidence, usually the file name.
Status of the dispute evidence.
Active, Inactive, Unknown Provenance of the dispute evidence.
Merchant, Payrails, Unknown MIME type of the evidence content.
Size of the evidence content in bytes.
Inline JSON payload for inline-context evidences. Present only for evidences created from inlineContexts; omitted for file-backed evidence.
Evidence library document this evidence is a version of. Present only for evidence library versions.
Version number within the evidence library document. Present only for evidence library versions.
When this evidence library version starts to apply. Present only for evidence library versions.
What changed in this evidence library version. Present only for evidence library versions that have a change note.
Workspace ID that the Dispute belongs to.
Labels assigned to this evidence for the dispute, used to categorise the document during representment.
Representment plan details for this dispute.
Hide child attributes
Hide child attributes
Unique identifier of the dispute in Payrails.
Date and time when the representment plan was created in Payrails.
Date and time when the representment plan was last updated in Payrails.
Status of the representment plan lifecycle.
GeneratingPlan, PlanReady, StoringEvidences, LabelingEvidences, Failed, EvidencesReady, GeneratingRepresentment, RepresentmentReady, Submitted Provider response identifier for representment plan generation.
Outcome of the last completed defense section generation.
Recommended action for the merchant (e.g. "defend" or "accept").
Explanation supporting the recommendation.
Defense reason codes with evidence options, grouped by provider reason code.
Hide child attributes
Hide child attributes
Adyen defense document type code.
Human-readable name for this defense document type.
Explanation of what this defense document type covers.
Whether this defense type is the recommended selection.
Evidence suggestions within this defense type.
Hide child attributes
Hide child attributes
Ordering position of this option within the defense type.
Suggested title for this evidence.
Suggested details to include for this evidence.
Whether this evidence is mandatory for the defense.
Machine-readable identifier for the evidence type.
ID of the uploaded evidence file.
Display metadata for the already-uploaded evidence file, present when evidenceId is set.
Hide child attributes
Hide child attributes
Human-readable file name or title of the uploaded evidence.
MIME type of the uploaded evidence file.
Size of the uploaded evidence file in bytes.
Ordered representment sections for this dispute.
Hide child attributes
Hide child attributes
Unique identifier of the representment section in Payrails.
Unique identifier of the dispute in Payrails.
Date and time when the representment section was created in Payrails.
Date and time when the representment section was last updated in Payrails.
Position of the section in the representment.
Indentation level of the section in the representment.
Type of representment section.
Text, Picture, Timeline Title of the text section when sectionType is Text.
Content of the text section when sectionType is Text.
Identifiers of the evidence the text section relies on, when sectionType is Text.
Linked evidence identifier when sectionType is Picture.
Label for the picture section when sectionType is Picture.
Status of the representment plan lifecycle.
GeneratingPlan, PlanReady, StoringEvidences, LabelingEvidences, Failed, EvidencesReady, GeneratingRepresentment, RepresentmentReady, Submitted Tags attached to this dispute.
Hide child attributes
Hide child attributes
Unique identifier of the Tag.
Human-readable display name of the Tag.
URL-safe identifier derived from the Tag name.
Hex color code used to render the Tag (e.g. "#EF4444").
Tag type slug. Determines cardinality and grouping (e.g. "merchant_status", "default").
UUID of the tag_types row this tag belongs to.
Whether multiple tags of this type can be attached to the same dispute at once. single means at most one tag of this type per dispute; multi allows many.
single, multi Date and time when the Tag was created.
Date and time when the Tag was last updated.
Workspace the Tag belongs to. Null for org-level tags visible to all workspaces.
Optional description of the Tag.
Date and time when the Tag was soft-deleted. Null if active.
AI classifications for the evidences associated with this dispute. Only present when includeEvidenceClassifications=true.
Hide child attributes
Hide child attributes
Unique identifier of the evidence file that was classified.
Unique identifier of the dispute the evidence belongs to.
Classification status.
classifying, classified, failed AI-generated summary of the evidence file content.
AI-inferred document type (e.g. "receipt", "shipping_label").
AI-generated statement of what the evidence proves in the dispute context.
List of key facts extracted from the evidence.
Representment plan slots this evidence is suggested to fill, ordered by confidence.
Hide child attributes
Hide child attributes
Defense reason code of the plan slot this evidence matches.
Slug identifier of the matching plan evidence slot.
Position of the matching slot within the defense type.
AI-generated explanation for why this evidence matches the slot.
Identifier of the LLM provider response that produced this classification.
Date and time when the classification was created.
Date and time when the classification was last updated.