Skip to content

Commit

Permalink
[Acceptance][Qris] Add deactivate payment routing documentation (#310)
Browse files Browse the repository at this point in the history
* Add deactivate payment routing documentation

* add response parameter

* update symbols
  • Loading branch information
Harits514 authored Dec 3, 2024
1 parent 20c57f7 commit 73185b8
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions source/includes/_payment_routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,50 @@ Use those mock receiver bank account for testing Payment Routing purpose. To sim
|1234567893|PENDING|
|1234567894|PENDING FORCE CREDIT|

## Deactivate Payment Routing

Use this API to **deactivate** an existing **QRIS transaction** created via payment routing using the same partner_trx_id inputted at creation.
Currently, only QRIS transaction created with **need_frontend** param set as false are able to be deactivated.

``` shell
curl --location --request DELETE 'https://partner.oyindonesia.com/api/payment-routing/mypartnertrxid123' \
--header 'Content-Type: application/json' \
--header 'x-oy-username: yourusername' \
--header 'x-api-key: apikeymu' \
```

> The above command returns JSON structured similar like this:
```json
{
"status": {
"code": "000",
"message": "Success"
}
}
```

### HTTPS Request
Endpoint:
**[Production]** `DELETE https://partner.oyindonesia.com/api/payment-routing/<partnerTrxId>` <br/>
**[Staging]** `DELETE https://api-stg.oyindonesia.com/api/payment-routing/<partnerTrxId>`

### Header
| Field | Description | Example |
| ------------- |:-------------:| ---------- |
| x-oy-username |Partner username | username |
| x-api-key | Partner api key | 6e87432c-2726-11ec-9621-0242ac130002 |

### URL Parameters
| Parameter | Type | Required | Description |
| ------------- |:-------------:| :----------: |:-----:|
|partnerTrxId | String | TRUE | Unique id inputted in creation process |

### Response Parameters
| Parameter | Type | Nullable | Description |
| ------------- |:-------------:| ----- | :----------: |
|status|Object| FALSE |Status of response in Object|


## Check Status Payment Routing Transaction

Expand Down Expand Up @@ -958,7 +1002,10 @@ Response Code | State | Description
400 | Final | Request is rejected (Token is already expired.)
429 | Final | Request Rejected (Too Many Request to specific endpoint)
203 | Final | Request is rejected (Duplicate Partner Tx Id)
204 | Final | Request is Rejected (Partner Trx ID not found on deactivation request)
247 | Final | Request is rejected (Email is not valid)
254 | Final | Request is Rejected (User credential not found, blocked, or invalid on deactivation request)
300 | Non Final | Request is rejected (Deactivation request failed)
901 | Non Final | General Error


Expand Down

0 comments on commit 73185b8

Please sign in to comment.