Get Refund
GetRefund retrieves a single refund with payment and invoice details
Authorization<token>
Bearer token
In: header
X-Organization-ID<token>
Tenant or organization identifier
In: header
Path Parameters
refundIdstring
Response Body
application/json
curl -X GET "https://api.nrings.io/v1/refunds/{refundId}" \ -H "Authorization: Bearer {your_token}" \ -H "X-Organization-ID: {your_org_id}"{
"refund": {
"id": "string",
"paymentId": "string",
"refundStatus": "REFUND_STATUS_UNSPECIFIED",
"amount": "string",
"currency": "string",
"providerRefundId": "string",
"paymentProvider": "string",
"failureReason": "string",
"processedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"status": "STATUS_UNSPECIFIED",
"timestamps": {
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
},
"payment": {
"id": "string",
"invoiceId": "string",
"paymentMethodId": "string",
"paymentStatus": "PAYMENT_STATUS_UNSPECIFIED",
"amount": "string",
"currency": "string",
"transactionId": "string",
"paymentProvider": "string",
"failureReason": "string",
"failureCode": "string",
"processedAt": "2019-08-24T14:15:22Z",
"refundAmount": "string",
"refundReason": "string",
"refundedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"status": "STATUS_UNSPECIFIED",
"timestamps": {
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
},
"invoice": {
"id": "string",
"invoiceNumber": "string",
"subscriptionId": "string",
"subscriptionIds": [
"string"
],
"periodStart": "2019-08-24T14:15:22Z",
"periodEnd": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"paidAt": "2019-08-24T14:15:22Z",
"status": "INVOICE_STATUS_UNSPECIFIED",
"currency": "string",
"subtotal": "string",
"taxAmount": "string",
"total": "string",
"amountDue": "string",
"transactionId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"metadata": {},
"issuer": {
"name": "string",
"legalName": "string",
"taxId": "string",
"vatId": "string",
"email": "string",
"phone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"address": "string",
"website": "string",
"isPlatform": true
},
"customer": {
"name": "string",
"legalName": "string",
"taxId": "string",
"vatId": "string",
"email": "string",
"phone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"address": "string",
"website": "string",
"isPlatform": true
}
}
}