Description

• This API allows Midtrans partners to exchange a user's GoPay payment linking token for a temporary token.
• The temporary token then can be used to initiate "Verify with Gopay" flow on behalf of the user, without asking the user to re-do the authentication process (Input Phone Number, OTP challenge, and Pin challenge).
• This is a backend-to-backend API. The caller must have a valid x-merchant-id, and must supply the user's GoPay payment linking token obtained from GoPay.

Request

Request Headers

Example

curl --location 'https://identity.midtrans.com/forward/gopay-id/identity/v1/gopay-id/token' \
  --header 'x-merchant-id: 5a6a693d-a13a-41c5-8f78-a0b02144220d' \
  --header 'correlation-id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
  --header 'authorization: MjAyMDA5MDFmOGQ0NWVhMi1iYzBjLTQ3ZTUtYjU1NC0wMDVjMzYyYzE3N2U6NGVlNzAyZmMtYWY2Ny00NjJjLWJmYTktZWQwMTBmZWQ4OTli'

Response

HTTP Status Codes

Success Response

Response Body:

{
  "success": true,
  "data": {
    "token": "<base64_encoded_jwt_token>"
  }
}

Error Responses

All error responses share the following structure:

{
  "success": false,
  "errors": [
    {
      "code": "<error_code>",
      "entity": "<field_or_entity>",
      "cause": "<description>"
    }
  ]
}

Bad Request

Example:

{
  "success": false,
  "errors": [
    {
      "code": "404",
      "entity": "gopayAccountId",
      "cause": "GoPay user not found"
    }
  ]
}

Internal Server Error

Example:

{
  "success": false,
  "errors": [
    {
      "code": "900",
      "entity": "identityToken",
      "cause": "Failed to generate identity token"
    }
  ]
}

Service Unavailable

A downstream dependency is temporarily unreachable. Retry with exponential backoff.

Example:

{
  "success": false,
  "errors": [
    {
      "code": "900",
      "entity": "upstreamService",
      "cause": "Service temporarily unavailable"
    }
  ]
}