Endpoint to initiate refund of Bancontact Payconiq Company payment to the debtor. This endpoint is idempotent based on 'Idempotency-Key' header. So the same request can be safely retried in case of timeout/network issue.
Payment Refund Service API (3.0.2)
API allows merchant/integrator to create/get/search payment refunds.
Download OpenAPI description
Languages
Servers
Mock server
https://docs.payconiq.be/_mock/apis/refund-public.openapi/
PREPROD merchant API
https://merchant.api.preprod.bancontact.net/
PROD merchant API
https://merchant.api.bancontact.net/
- Mock server
https://docs.payconiq.be/_mock/apis/refund-public.openapi/payments/{payment-id}/refunds
- PREPROD merchant API
https://merchant.api.preprod.bancontact.net/payments/{payment-id}/refunds
- PROD merchant API
https://merchant.api.bancontact.net/payments/{payment-id}/refunds
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.payconiq.be/_mock/apis/refund-public.openapi/payments/{payment-id}/refunds' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: string' \
-H 'Signature: YOUR_API_KEY_HERE' \
-d '{
"amount": 1,
"currency": "EUR",
"description": "string"
}'Refund successfully created
Detached JWS signature of response payload. Bancontact Payconiq Company hosts the Public Key in JWK format as JWKS at:
https://jwks.bancontact.net/
https://jwks.preprod.bancontact.net/ for PROD and PREPROD environments respectively. The Public Key should be downloaded from these URLs and identified by the 'kid' claim in the JOSE header. Bancontact Payconiq Company will use the same algorithm to sign the response as the one used for the request signature. The signature must be computed as per following instructions:
jws = base64URLEncode(JOSE Header)..alg(base64URLEncode(JOSE Header).base64URLEncode(Request Body))
{ "typ": "jose+json", "kid": "JWK kid", "alg": "ES256(ECDSA using P-256 and SHA-256. Minimum keysize 256 bit) or RS256(RSASSA-PKCS1-v1_5usingSHA-256 Minimum key length 2048 bit)", "https://payconiq.com/sub" : "{bankUserId}", "https://payconiq.com/iss" : "Payconiq", "https://payconiq.com/iat" : "{Current creation date time in ISODateTime format, expressed in UTC time format(YYYY-MM-DDThh:mm:ss.sssZ)}, "https://payconiq.com/jti" : "{X-Request-ID}", "https://payconiq.com/path": "request path eg. /bag/v1/payments/{payment-id}/authorization/{authorization-id}/confirm" "crit": ["https://payconiq.com/sub", "https://payconiq.com/iss", "https://payconiq.com/iat", "https://payconiq.com/jti", "https://payconiq.com/path"] }
JWS Payload MUST be the same as response body as base64url encoded JSON data.
Refund status after creation. Always has value 'PENDING', because refund processing is asynchronous. Current status can be checked using GET '/v3/payments/{payment-id}/refunds/{refund-id}' endpoint.
Value"PENDING"
Response
application/json
{ "refundId": "stringstringstringstring", "paymentId": "stringstringstringstring", "status": "PENDING", "amount": 1, "currency": "EUR", "description": "string", "creationDate": "2019-08-24T14:15:22Z" }
- Mock server
https://docs.payconiq.be/_mock/apis/refund-public.openapi/payments/{payment-id}/refunds/{refund-id}
- PREPROD merchant API
https://merchant.api.preprod.bancontact.net/payments/{payment-id}/refunds/{refund-id}
- PROD merchant API
https://merchant.api.bancontact.net/payments/{payment-id}/refunds/{refund-id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.payconiq.be/_mock/apis/refund-public.openapi/payments/{payment-id}/refunds/{refund-id}' \
-H 'Signature: YOUR_API_KEY_HERE'return refund details
Detached JWS signature of response payload. Bancontact Payconiq Company hosts the Public Key in JWK format as JWKS at:
https://jwks.bancontact.net/
https://jwks.preprod.bancontact.net/ for PROD and PREPROD environments respectively. The Public Key should be downloaded from these URLs and identified by the 'kid' claim in the JOSE header. Bancontact Payconiq Company will use the same algorithm to sign the response as the one used for the request signature. The signature must be computed as per following instructions:
jws = base64URLEncode(JOSE Header)..alg(base64URLEncode(JOSE Header).base64URLEncode(Request Body))
{ "typ": "jose+json", "kid": "JWK kid", "alg": "ES256(ECDSA using P-256 and SHA-256. Minimum keysize 256 bit) or RS256(RSASSA-PKCS1-v1_5usingSHA-256 Minimum key length 2048 bit)", "https://payconiq.com/sub" : "{bankUserId}", "https://payconiq.com/iss" : "Payconiq", "https://payconiq.com/iat" : "{Current creation date time in ISODateTime format, expressed in UTC time format(YYYY-MM-DDThh:mm:ss.sssZ)}, "https://payconiq.com/jti" : "{X-Request-ID}", "https://payconiq.com/path": "request path eg. /bag/v1/payments/{payment-id}/authorization/{authorization-id}/confirm" "crit": ["https://payconiq.com/sub", "https://payconiq.com/iss", "https://payconiq.com/iat", "https://payconiq.com/jti", "https://payconiq.com/path"] }
JWS Payload MUST be the same as response body as base64url encoded JSON data.
- PENDING - refund request accepted by Bancontact Payconiq Company, will be processed soon
- REFUNDED - refund request successfully processed and money moved from merchant to debtor
- FAILED - refund request processing failed for technical reasons, money movement didn't happen
Enum"PENDING""REFUNDED""FAILED"
Response
application/json
{ "refundId": "stringstringstringstring", "paymentId": "stringstringstringstring", "amount": 1, "currency": "EUR", "status": "PENDING", "description": "string", "creationDate": "2019-08-24T14:15:22Z" }