This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /partners/{partnerId}/payment-methods
Get list of payment methods related to partner
Description
Returns list of payment methods
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| partnerId | required | Id of partner. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| keyword[eq] | optional | Search for payment method by keyword. Allowed expression(s): eq, ct | |
| include | optional | The resources that can be included in this request, delimited by a comma: partner, bank |
Responses
200
successful operation
Response content JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
{
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"name",
"currency"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"bank_id": {
"description": "Id of bank partner",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"ref": {
"description": "Unique reference code",
"type": "string",
"format": "string",
"example": "XYZ"
},
"currency": {
"description": "ISO 4217 Currency Codes 3 letter currency code",
"type": "string",
"format": "string",
"example": "DKK"
},
"currency_fallback": {
"description": "If this account is a fallback in case the currency doesnt match any other payment method",
"type": "boolean",
"format": "boolean",
"example": true
},
"iban": {
"description": "IBAN",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of payment method",
"type": "string",
"format": "string",
"example": "A string"
},
"ocr_pattern": {
"description": "OCR pattern",
"type": "string",
"format": "string",
"example": "A string"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"payment_instruction": {
"description": "Payment instruction",
"type": "string",
"format": "string",
"example": "A string"
},
"swift_bic": {
"description": "Swift/BIC code",
"type": "string",
"format": "string",
"example": ""
},
"type": {
"description": "Bank account reference number",
"type": "string",
"format": "string",
"example": "bank_account"
},
"bankgiro": {
"description": "Bankgiro reference number",
"type": "string",
"format": "string",
"example": "1234-5678"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
},
"meta": {
"description": "Meta with pagination",
"properties": {
"current_page": {
"description": "The current page",
"type": "integer"
},
"from": {
"description": "The starting position of the current page results",
"type": "integer"
},
"last_page": {
"description": "The last page",
"type": "integer"
},
"path": {
"description": "The current path of the request",
"type": "string"
},
"per_page": {
"description": "Records that are displayed pr request",
"type": "integer"
},
"to": {
"description": "The ending position of the current page results",
"type": "integer"
},
"total": {
"description": "Number of records that are matched by the current query",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
500
internal server error
POST /partners/{partnerId}/payment-methods
Create new payment method
Description
Create a new payment method
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| partnerId | required | Id of partner. |
Request body
Description
Target payment method.
Required
This parameter is required.
Request body JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
"required": [
"name",
"currency"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"bank_id": {
"description": "Id of bank partner",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"ref": {
"description": "Unique reference code",
"type": "string",
"format": "string",
"example": "XYZ"
},
"currency": {
"description": "ISO 4217 Currency Codes 3 letter currency code",
"type": "string",
"format": "string",
"example": "DKK"
},
"currency_fallback": {
"description": "If this account is a fallback in case the currency doesnt match any other payment method",
"type": "boolean",
"format": "boolean",
"example": true
},
"iban": {
"description": "IBAN",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of payment method",
"type": "string",
"format": "string",
"example": "A string"
},
"ocr_pattern": {
"description": "OCR pattern",
"type": "string",
"format": "string",
"example": "A string"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"payment_instruction": {
"description": "Payment instruction",
"type": "string",
"format": "string",
"example": "A string"
},
"swift_bic": {
"description": "Swift/BIC code",
"type": "string",
"format": "string",
"example": ""
},
"type": {
"description": "Bank account reference number",
"type": "string",
"format": "string",
"example": "bank_account"
},
"bankgiro": {
"description": "Bankgiro reference number",
"type": "string",
"format": "string",
"example": "1234-5678"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
Responses
201
successful operation
Response content JSON schema
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
"properties": {
"required": [
"name",
"currency"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"bank_id": {
"description": "Id of bank partner",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"ref": {
"description": "Unique reference code",
"type": "string",
"format": "string",
"example": "XYZ"
},
"currency": {
"description": "ISO 4217 Currency Codes 3 letter currency code",
"type": "string",
"format": "string",
"example": "DKK"
},
"currency_fallback": {
"description": "If this account is a fallback in case the currency doesnt match any other payment method",
"type": "boolean",
"format": "boolean",
"example": true
},
"iban": {
"description": "IBAN",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of payment method",
"type": "string",
"format": "string",
"example": "A string"
},
"ocr_pattern": {
"description": "OCR pattern",
"type": "string",
"format": "string",
"example": "A string"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"payment_instruction": {
"description": "Payment instruction",
"type": "string",
"format": "string",
"example": "A string"
},
"swift_bic": {
"description": "Swift/BIC code",
"type": "string",
"format": "string",
"example": ""
},
"type": {
"description": "Bank account reference number",
"type": "string",
"format": "string",
"example": "bank_account"
},
"bankgiro": {
"description": "Bankgiro reference number",
"type": "string",
"format": "string",
"example": "1234-5678"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
422
Has validation errors
500
internal server error